Shared Queue Message Loader
Shared Queue Message Loader reads recovery messages generated by the Shared Queue Message Generator CANCEL step and loads the messages to the shared queue. It also generates reports that summarize the message loading process.
- Reads recovery messages generated by the Shared Queue Message Generator CANCEL step and loads the messages to the shared queue through the CQS API. If a message to be loaded already exists in the shared queue, it skips loading that message and logs the information in the report.
- Generates a summary report and a detail report of the message loading process.
RECOV4 JCL Shared Message Loader step example
RECOV4 JCL is generated by JCL Generator. See JCL Generator.
DD statements for Shared Queue Message Loader job step
- STEPLIB DD
- Defines the library that contains the IMS Queue Control Facility program load modules and the library that contains the IMS program load modules. Required.
- QCFPRINT DD
- Defines the output report data set. Required.
- QCFRVMSG DD
- Specifies the name of the data set that contains the recovery messages generated by the Shared Queue Message Generator CANCEL step.
Control statements for Shared Queue Message Loader job step
Use the LOADTOSQ function to load selected messages to the IMS message queues in shared-queues environments.
The LOADTOSQ function puts selected messages from an input data set (that is created by the Shared Queue Message Generator) to the IMS message queues.
To specify the messages that you want to load into the IMS message queue, you provide control statements to LOADTOSQ through IMS Queue Control Facility control processing in the LOADTOSQ step. These control statements specify the criteria for selecting messages.
- * comment (See Comment (*) statement)
- CQSSSN
- EXCLUDE (Only DESTINATION= and DESTYPE= parameters are supported)
- INCLUDE (Only DESTINATION= and DESTYPE= parameters are supported)
- SELECT
- SQMSTRNM
- FUNCTION LOADTOSQ statement syntax
- Specify the FUNCTION LOADTOSQ keywords and parameters according to the following syntactic
conventions.
- CQSSSN statement
- Use the CQSSSN statement of the LOADTOSQ function to specify the 1- to 4-character name for the CQS subsystem to load the recovery messages generated by Shared Queue Message Generator logic.
- SQMSTRNM statement
- Use the SQMSTRNM statement of LOADTOSQ function to specify the 1- to 16-character name of the primary structure that contains the shared message queues.
- FUNCTION LOADTOSQ INCLUDE statement syntax
- FUNCTION LOADTOSQ can use the INCLUDE control statement to choose certain messages.
The INCLUDE control statement for FUNCTION LOADTOSQ supports DESTINATION and DESTYPE parameters only.
In the JCL, the INCLUDE control statement is written on a separate line after the FUNCTION LOADTOSQ control statement.
See INCLUDE statement for the INCLUDE statement syntax.
- FUNCTION LOADTOSQ EXCLUDE statement syntax
- FUNCTION LOADTOSQ can use the EXCLUDE control statement to exclude certain messages.
The EXCLUDE control statement for FUNCTION LOADTOSQ supports DESTINATION and DESTYPE parameters only.
In the JCL, the EXCLUDE control statement is written on a separate line after the FUNCTION LOADTOSQ control statement.
See EXCLUDE statement for the EXCLUDE statement syntax.
- FUNCTION LOADTOSQ SELECT statement syntax
- FUNCTION LOADTOSQ can use the SELECT control statement to select messages that meet
particular criteria.
In the JCL, the SELECT control statement is written on a separate line after the FUNCTION LOADTOSQ control statement.
- NOSYSMSG statement
- Specifies that no system messages are to be selected. You can bypass the loading of IMS system messages.
- NOCONVMSG statement
- Specifies that no conversational messages are to be selected except for MSC response conversational messages, which are always selected. You can bypass loading of conversational messages except for MSC response conversational messages.
- RECOVMSG statement
- Specifies that only recoverable messages are to be selected. You can bypass loading of non-recoverable messages.
- NOINTMSG statement
- Specifies that no IMS internal messages are to be selected. You can bypass the loading of IMS internal messages.
- NOEXPMSG statement
- Specifies that no expired messages exceeding the EXPRTIME of the TRANSACT macro are to be selected. You can bypass the loading of expired messages.
Reports (QCFPRINT DD)
- LOADTOSQ Processing Routine report (Ldtosq001)
- Processing Summary report (Ldtosq002)
- Shared Queue Message Loader Summary report (Ldtosq003)
- Shared Queue Message Loader Detail report (Ldtosq004)
- Shared Queue Message Loader Skipped Messages report (Ldtosq005)
If any error occurs during the load process, the reports will contain only the information available at that point in time.
Ldtosq001: The LOADTOSQ Processing Routine report contains control statements and messages for statement errors, if any.
Page 1 IMS Queue Control Facility V4R1 (5698-N50) System Date: 2024.157
Report: Ldtosq001 LOADTOSQ Processing Routine System Time: 08.18.04
LOADTOSQ Control Records and Comments
_____________________________________
FUNCTION LOADTOSQ,CQSSSN=CQS3,SQMSTRNM=GJECQSQMSG1
EXCLUDE DESTINATION=A* Ldtosq002: The Processing Summary report contains EXEC parameter specifications and error messages.
Page 2 IMS Queue Control Facility V4R1 (5698-N50) System Date: 2024.157
Report: Ldtosq002 Shared Queue Message Loader Processing Routine System Time: 08:18:04
CQS subsystem name: CQS3
MSGQ structure name: GJECQSQMSG1
Shared Queue Message Loader ended successfully. Ldtosq003: The Shared Queue Message Loader Summary report lists the number of loaded messages by the queue type. If some messages already existed in the shared queue and the load process was skipped, that number is also displayed.
Page 3 IMS Queue Control Facility V4R1 (5698-N50) System Date: 2024.157
Report: Ldtosq003 Shared Queue Message Loader Summary Report System Time: 08:18:04
Processing Summary:
Number of processed records in QCFRVMSG: 17
Number of recovered messages: Primary: 8 Secondary: 8
Number of skipped messages: Primary: 1 Secondary: 0
Summary of recovered messages in each Queue type
Queue Type Primary Secondary Oldest Message Time Newest Message Time Zone
---------------------------- -------- --------- ---------------------------- ---------------------------- ------
Transaction Ready Queue 3 4 D=2024.131 T=02:55:21.659388 D=2024.145 T=08:18:54.870327 -03:00
Transaction Serial Queue 3 0 D=2024.131 T=06:52:30.439766 D=2024.131 T=06:52:33.285467 -03:00
OTMA Ready Rueue 2 4 D=2024.131 T=02:52:59.413755 D=2024.145 T=08:17:44.975366 -03:00 Ldtosq004: The Shared Queue Message Loader Detail report contains a summary of the load process and information about the loaded messages for each queue type:
- The number of recovered messages
- The number of skipped messages
- The number of messages processed and timestamp information of the oldest message and the newest message for each destination
Page 4 IMS Queue Control Facility V4R1 (5698-N50) System Date: 2024.157
Report: Ldtosq004 Shared Queue Message Loader Detail Report System Time: 08:18:04
Queue Type: Transaction Ready Queue
Number of recovered messages: Primary: 3 Secondary: 4
Number of skipped messages: Primary: 1 Secondary: 0
Destination Primary Secondary Oldest Message Time Newest Message Time Zone
------------------------- -------- --------- ---------------------------- ---------------------------- ------
DSPINV 1 0 D=2024.131 T=02:56:12.537877 D=2024.131 T=02:56:12.537877 -03:00
PART 2 4 D=2024.131 T=02:55:21.659388 D=2024.145 T=08:18:54.870327 -03:00
Page 5 IMS Queue Control Facility V4R1 (5698-N50) System Date: 2024.157
Report: Ldtosq004 Shared Queue Message Loader Detail Report System Time: 08:18:04
Queue Type: Transaction Serial Queue
Number of recovered messages: Primary: 3 Secondary: 0
Number of skipped messages: Primary: 0 Secondary: 0
Destination Primary Secondary Oldest Message Time Newest Message Time Zone
------------------------- -------- --------- ---------------------------- ---------------------------- ------
MPPTRX03 3 0 D=2024.131 T=06:52:30.439766 D=2024.131 T=06:52:33.285467 -03:00 Ldtosq005: The Shared Queue Message Loader Skipped Messages report contains information about the messages whose loading process was skipped for each queue type.
The report contains the number of messages whose loading process was skipped and timestamp information of the oldest message and the newest message for each destination.
This report is generated only if either of the following conditions is met:
- A message was not loaded because the same message already exists in the shared queue.
- A message did not meet the selection criteria specified by SELECT, INCLUDE or EXCLUDE statement.
Page 8 IMS Queue Control Facility V4R1 (5698-N50) System Date: 2024.157
Report: Ldtosq005 Shared Queue Message Loader Skipped Messages System Time: 08:18:04
Queue Type: Transaction Ready Queue
Destination Primary Secondary Oldest Message Time Newest Message Time Zone
------------------------- -------- --------- ---------------------------- ---------------------------- ------
ADDPART 1 0 D=2024.131 T=02:56:25.443861 D=2024.131 T=02:56:25.443861 -03:00 Return codes
| Return code | Meaning |
|---|---|
| 00 | The job ended successfully. |
| 04 | The job ended successfully; however, no messages were loaded. Either no messages met the selection criteria or all the messages that met the selection criteria already exist in the shared queue. |
| 08 | The job failed. The report contains any information available at the time of the error. |
