SAP QUEUE_SCHEDULE Function Module for Planning the background processing job of a queue









QUEUE_SCHEDULE is a standard queue schedule SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Planning the background processing job of a queue processing and below is the pattern details for this FM, showing its interface including any import and export parameters, exceptions etc. there is also a full "cut and paste" ABAP pattern code example, along with implementation ABAP coding, documentation and contribution comments specific to this or related objects.


See here to view full function module documentation and code listing for queue schedule FM, simply by entering the name QUEUE_SCHEDULE into the relevant SAP transaction such as SE37 or SE38.

Function Group: SQUE
Program Name: SAPLSQUE
Main Program: SAPLSQUE
Appliation area: S
Release date: N/A
Mode(Normal, Remote etc): Normal Function Module
Update: 2



Function QUEUE_SCHEDULE pattern details

In-order to call this FM within your sap programs, simply using the below ABAP pattern details to trigger the function call...or see the full ABAP code listing at the end of this article. You can simply cut and paste this code into your ABAP progrom as it is, including variable declarations.
CALL FUNCTION 'QUEUE_SCHEDULE'"Planning the background processing job of a queue
EXPORTING
* COMMITX = ' ' "carry out implicit COMMIT (for VB2)
* DATE = ' ' "Date of processing
* NAME = ' ' "Queue Identifier
* PROGRAM = ' ' "allocated queue processing program
* START = ' ' "Start mode of the processing program
* TIME = ' ' "Time of processing

EXCEPTIONS
INVALID_PARAMETER = 1 SCHEDULE_PROBLEM = 2
.



IMPORTING Parameters details for QUEUE_SCHEDULE

COMMITX - carry out implicit COMMIT (for VB2)

Data type: APQI-STARTMODE
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

DATE - Date of processing

Data type: APQI-STARTDATE
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

NAME - Queue Identifier

Data type: APQI-QID
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

PROGRAM - allocated queue processing program

Data type: APQI-STARTPGID
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

START - Start mode of the processing program

Data type: APQI-STARTMODE
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

TIME - Time of processing

Data type: APQI-STARTTIME
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

EXCEPTIONS details

INVALID_PARAMETER - missing or invalid parameter

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

SCHEDULE_PROBLEM - Background planning for program failed

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

Copy and paste ABAP code example for QUEUE_SCHEDULE Function Module

The ABAP code below is a full code listing to execute function module POPUP_TO_CONFIRM including all data declarations. The code uses the original data declarations rather than the latest in-line data DECLARATION SYNTAX but I have included an ABAP code snippet at the end to show how declarations would look using the newer method of declaring data variables on the fly. This will allow you to compare and fully understand the new inline method. Please note some of the newer syntax such as the @DATA is not available until a later 4.70 service pack (SP8), which i why i have stuck to the origianl for this example.

DATA:
lv_commitx  TYPE APQI-STARTMODE, "   SPACE
lv_invalid_parameter  TYPE APQI, "   
lv_date  TYPE APQI-STARTDATE, "   SPACE
lv_schedule_problem  TYPE APQI, "   
lv_name  TYPE APQI-QID, "   SPACE
lv_program  TYPE APQI-STARTPGID, "   SPACE
lv_start  TYPE APQI-STARTMODE, "   SPACE
lv_time  TYPE APQI-STARTTIME. "   SPACE

  CALL FUNCTION 'QUEUE_SCHEDULE'  "Planning the background processing job of a queue
    EXPORTING
         COMMITX = lv_commitx
         DATE = lv_date
         NAME = lv_name
         PROGRAM = lv_program
         START = lv_start
         TIME = lv_time
    EXCEPTIONS
        INVALID_PARAMETER = 1
        SCHEDULE_PROBLEM = 2
. " QUEUE_SCHEDULE




ABAP code using 7.40 inline data declarations to call FM QUEUE_SCHEDULE

The below ABAP code uses the newer in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. Please note some of the newer syntax below, such as the @DATA is not available until 4.70 EHP 8.

"SELECT single STARTMODE FROM APQI INTO @DATA(ld_commitx).
DATA(ld_commitx) = ' '.
 
 
"SELECT single STARTDATE FROM APQI INTO @DATA(ld_date).
DATA(ld_date) = ' '.
 
 
"SELECT single QID FROM APQI INTO @DATA(ld_name).
DATA(ld_name) = ' '.
 
"SELECT single STARTPGID FROM APQI INTO @DATA(ld_program).
DATA(ld_program) = ' '.
 
"SELECT single STARTMODE FROM APQI INTO @DATA(ld_start).
DATA(ld_start) = ' '.
 
"SELECT single STARTTIME FROM APQI INTO @DATA(ld_time).
DATA(ld_time) = ' '.
 


Search for further information about these or an SAP related objects



Comments on this SAP object

What made you want to lookup this SAP object? Please tell us what you were looking for and anything you would like to be included on this page!