System service call summary

The following table summarizes which system service calls you can use in each type of IMS DB application program and the parameters for each call. Optional parameters are enclosed in brackets ([ ]).

Exception: Language-dependent parameters are not shown here.

For more information on language-dependent application elements, see the topic "Defining Application Program Elements" in IMS Version 15.5 Application Programming.

Table 1. Summary of system service calls
Function Code Meaning Use/Options Parameters Valid for
APSB Allocate PSB Allocates a PSB for an ODBA application aib DB/DC, IMS DB
DPSB Deallocate PSB Deallocates a PSB for an ODBA application aib DB/DC, IMS DB
CHKP (Basic) Basic checkpoint Prepares for recovery function, i/o pcb or aib, i/o area DB batch, TM batch, BMP, MPP, IFP
CHKP (Symbolic) Symbolic checkpoint Prepares for recovery. Specifies up to seven program areas to be saved function, i/o pcb or aib, i/o area len, i/o area[, area len, area] DB batch, TM batch, BMP
GMSG Get Message Retrieves a message from the AO exit routine. Waits for an AOI message when none is available function, aib, i/o area DB/DC and DCCTL (BMP, MPP, IFP), DB/DC and DBCTL (DRA thread), DBCTL (BMP non-message driven), ODBA
GSCD1 Get System Contents Directory Gets address of system contents directory function, db pcb, i/o pcb or aib, i/o area DB Batch, TM Batch
ICMD Issue Command Issues an IMS command and retrieves the first command response segment function, aib, i/o area DB/DC and DCCTL (BMP, MPP, IFP), DB/DC and DBCTL (DRA thread), DBCTL (BMP non-message driven), ODBA
INIT Initialize application Receives data availability and deadlock occurrence status codes and checks each PCB database for data availability function, i/o pcb or aib, i/o area DB batch, TM batch, BMP, MPP, IFP, DBCTL, ODBA
INQY Inquiry Returns information and status codes about I/O or alternate PCB destination type, location, and session status function, aib, i/o area, AIBFUNC=FIND| DBQUERY| ENVIRON| ENVIRON2 DB batch, TM batch, BMP, MPP, IFP, ODBA
LOGb Log Writes a message to the system log function, i/o pcb or aib, i/o area DB batch, TM batch, BMP, MPP, IFP, DBCTL, ODBA
PCBb Program Communication Block Specifies and schedules another PSB function, psb name, uibptr, [,sysserve] CICS® (DBCTL or DB/DC)
RCMD Retrieve Command Retrieves the second and subsequent command response segments resulting from an ICMD call function, aib, i/o area DB/DC and DCCTL (BMP, MPP, IFP), DB/DC and DBCTL (DRA thread), DBCTL (BMP non-message driven), ODBA
ROLB Roll back Eliminates database updates and returns last message to i/o area function, i/o pcb or aib, i/o area DB batch, TM batch, BMP, MPP, IFP
ROLL Roll Eliminates database updates function DB batch, TM batch, BMP, MPP, IFP
ROLS Roll back to SETS Issues call using name of DB PCB or i/o PCB and backs out database changes to SETS points function, db pcb, i/o pcb or aib, i/o area, token DB batch, TM batch, BMP, MPP, IFP, DBCTL, ODBA
SETS/SETU Set a backout point Cancels all existing backout points and establishes as many as nine intermediate backout points function, i/o pcb or aib, i/o area, token DB batch, TM batch, BMP, MPP, IFP, DBCTL, ODBA
SNAP2   Collects diagnostic information; choose SNAP options function, db pcb or aib, i/o area DB batch, BMP, MPP, IFP, CICS (DBCTL or DB/DC), ODBA
STAT3 Statistics Retrieves IMS system statistics; choose type and format function, db pcb or aib, i/o area, stat function DB batch, BMP, MPP, IFP, DBCTL, ODBA
SYNC Synchronization Releases locked resources and requests commit-point processing function, i/o pcb or aib BMP
TERM Terminate Releases a PSB so another can be scheduled to commit database changes function CICS (DBCTL or DB/DC)
XRST Extended restart Specifies up to seven areas to be saved. Works with symbolic checkpoint to restart application program function, i/o pcb or aib, i/o area len, i/o area[, area len, area] DB batch, TM batch, BMP
Note:
  1. GSCD is a Product-sensitive Programming Interface.
  2. SNAP is a Product-sensitive Programming Interface.
  3. STAT is a Product-sensitive Programming Interface.