SAP CLOI_QUEUE_CHECK Function Module for Check IDoc relevant queues

Search SAP Function Modules

CLOI_QUEUE_CHECK is a standard cloi queue check SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Check IDoc relevant queues 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 cloi queue check FM, simply by entering the name CLOI_QUEUE_CHECK into the relevant SAP transaction such as SE37 or SE38.

Function Group: LOI1
Program Name: SAPLLOI1
Main Program: SAPLLOI1
Appliation area: M
Release date: N/A
Mode(Normal, Remote etc): Remote-Enabled
Update:

Function CLOI_QUEUE_CHECK 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 'CLOI_QUEUE_CHECK'"Check IDoc relevant queues
  EXPORTING
   RECEIVING_LOGSYS =  "logical system of the receiving system
*  FLG_IDOC_QUEUE_CHECK =  "flag to check the IDoc queue
*  FLG_TRFC_QUEUE_CHECK =  "flag to check the TRFC queue
*  START_TIME =  "start time used to select queue entries
*  START_DATE =  "start date used to select queue entries
*  END_TIME =  "end time used to select queue entries
*  END_DATE = SY-DATUM "end date used to select queue entries
*  MAX_QUEUE_ENTRIES = 500 "max. number of queue entries to return

 IMPORTING
   IDOC_QUEUE_ENTRIES =  "number of selected entries in IDoc queue
   TRFC_QUEUE_ENTRIES =  "number of selected entries in TRFC queue

TABLES
*  IDOC_QUEUE =  "entries in IDOC queue
*  TRFC_QUEUE =  "entries in TRFC queue

EXCEPTIONS
   LOGSYS_NOT_DEFINED = 1    ERROR_READING_PARTNER_PROFILE = 2 

.

Customer Function user exits

Below is a list of CUSTOMER FUNCTION exit user exits that are available within this program and maybe relevant for this FM.
EXIT_SAPLLOI1_001 User exit for planned orders
EXIT_SAPLLOI1_002 User exit for production orders
EXIT_SAPLLOI1_003 User exit for current stock/requirements lists
EXIT_SAPLLOI1_004 User exit for run schedule headers
EXIT_SAPLLOI1_005 User exit for BOMs
EXIT_SAPLLOI1_006 User exit for routings
EXIT_SAPLLOI1_007 User exit for work centers
EXIT_SAPLLOI1_008 User exit for hierarchies/resource networks
EXIT_SAPLLOI1_009 User exit for calendars

IMPORTING Parameters details for CLOI_QUEUE_CHECK

RECEIVING_LOGSYS - logical system of the receiving system

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

FLG_IDOC_QUEUE_CHECK - flag to check the IDoc queue

Data type: CLOI_PARA-XFLAG
Optional: Yes
Call by Reference: No ( called with pass by value option)

FLG_TRFC_QUEUE_CHECK - flag to check the TRFC queue

Data type: CLOI_PARA-XFLAG
Optional: Yes
Call by Reference: No ( called with pass by value option)

START_TIME - start time used to select queue entries

Data type: EDIDC-CRETIM
Optional: Yes
Call by Reference: No ( called with pass by value option)

START_DATE - start date used to select queue entries

Data type: EDIDC-CREDAT
Optional: Yes
Call by Reference: No ( called with pass by value option)

END_TIME - end time used to select queue entries

Data type: EDIDC-CRETIM
Optional: Yes
Call by Reference: No ( called with pass by value option)

END_DATE - end date used to select queue entries

Data type: EDIDC-CREDAT
Default: SY-DATUM
Optional: Yes
Call by Reference: No ( called with pass by value option)

MAX_QUEUE_ENTRIES - max. number of queue entries to return

Data type: I
Default: 500
Optional: Yes
Call by Reference: No ( called with pass by value option)

EXPORTING Parameters details for CLOI_QUEUE_CHECK

IDOC_QUEUE_ENTRIES - number of selected entries in IDoc queue

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

TRFC_QUEUE_ENTRIES - number of selected entries in TRFC queue

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

TABLES Parameters details for CLOI_QUEUE_CHECK

IDOC_QUEUE - entries in IDOC queue

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

TRFC_QUEUE - entries in TRFC queue

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

EXCEPTIONS details

LOGSYS_NOT_DEFINED - The logical system used is not defined

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

ERROR_READING_PARTNER_PROFILE - An error occured when reading the partner prof.

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

Copy and paste ABAP code example for CLOI_QUEUE_CHECK 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.

ABAP code using 7.40 inline data declarations to call FM CLOI_QUEUE_CHECK

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.

Search for further information about these or an SAP related objects