qRFC API for the Inbound Queue 

The following list describes the functions of the qRFC API with which you can administer the inbound queue and process your elements.

 

TRFC_GET_QIN_INFO and TRFC_GET_QIN_INFO_DETAILS

●      Shows the current content of one or all inbound queues.

 

See also the program RSTRFCIR.

 

TRFC_QIN_GET_CURRENT_PARAM

●      Gets the following information about inbound queues: Queue name and queue counter assignment for the current LUW. You need this information if you use the Re-use function in qRFC with inbound queue.

 

TRFC_QIN_ACTIVATE

●      You use this function module if you want to specify a queue name (single or generic, for example BASIS_TEST_*) and a destination to process one or more queues. You should only use this function if the queue is blocked due to a communication error, or if a system or application exception has occurred and the problem has already been solved. You can also use it if the LUWs have been saved in the inbound queue and need to be reactivated.

●      A queue that has been blocked by calling the function TRFC_QIN_STOP cannot be processed using this function.

○       If you set the import parameter MAXLUW to a value not equal to 0, the qRFC Manager activates all LUWs in the inbound queue.

○       If you set the import parameter MAXTIME to a value not equal to 0 (0 = the call is returned as soon as the queue is empty), the qRFC Manager only activates the queue within the specified time. If the time runs out while the last LUW is being processed, this call is returned after the last LUW.

○       If you change the import parameter MODE to B, the qRFC Manager activates the queue (executes the qRFC LUWs) in a background task. The import parameters are optional for the start of this background job (default: immediately).

○       If you change the import parameter MODE to L, the qRFC Manager processes all qRFC LUWs in a queue in the context of the caller. If an exception occurs in a function module in this queue, this results in a short dump because the qRFC Manager cannot detect the exception in this session.

○       If you set the import parameter USERDEST to a "local" RFC destination (for example, a logical destination with NONE or SPACE as a reference destination) in SM59, the qRFC Manager processes all qRFC LUWs in a queue under the user who is currently logged on. If no destination is entered, or the user has not been defined, the current user is used.

 

See also the program RSTRFCI0.

 

TRFC_QIN_DELETE_LUW

●      Deletes the LUW in an inbound queue (defined by the import parameter TID).

 

TRFC_QIN_DELETE_QUEUE

●      Deletes the entire inbound queue defined by import parameter QNAME.

 

TRFC_QIN_GET_CURRENT_QUEUES

●      Shows all current existing queues.

 

TRFC_QIN_GET_ERROR_QUEUES

●      Displays all queues with errors that are blocked because of one of the following status settings: SYSFAIL, CPICERR, RETRY, ARETRY, ANORETRY.

○       Queues that have the status WAITING are not displayed.

 

TRFC_QIN_GET_FIRST_LUW

●      Displays information (such as the TID) for the first LUW in a queue.

 

TRFC_QIN_GET_HANGING_QUEUES

●      This function displays all blocked queues, including the queues that the application has explicitly written in the queue for later processing and have the status WAITING.

○       This function displays all queues that have the status WAITING. To see queues with errors, use function module TRFC_QIN_GET_ERROR_QUEUES.

 

TRFC_QIN_OVERVIEW

●      Gets an overview of the current inbound queues. These can have various optional import parameters, for example, queue name or SAP client.

 

TRFC_QIN_RESTART

●      You use this function module if you want to specify a queue name (single or generic, for example BASIS_TEST_*) to continue processing one or more queues, regardless of whether or not these queues have previously been stopped.

○       If you change the import parameter FORCE to SPACE, the qRFC Manager reduces the STOPcounter and, if the counter is on 0, activates the queue. Otherwise, the qRFC Manager will always activate the queue, whatever the status of the STOP counter.

○       If you set the import parameter MAXLUW to a value not equal to 0, the qRFC Manager activates all LUWs in the inbound queue.

○       If a queue has been stopped, use this call and not TRFC_QIN_ACTIVATE.

○       If you change the importing parameter NO_ACTIVATE to ‘X’, the qRFC Manager unlocks the queue, but does not activate it.

○       If you set the import parameter MAXTIME to a value not equal to 0 (0 = the call is returned as soon as the queue is empty), the qRFC Manager only activates the queue within this time. If the time runs out while the last LUW is being processed, this call is returned as soon as the last LUW is processed.

○       If you set the import parameter MODE to 'B', the qRFC Manager activates the queue and processes the qRFC LUWs in a background job. The import parameters are optional to start of this background job (default: immediately).

○       If you set the import parameter MODE to L, the qRFC Manager processes all qRFC LUWs in a queue in the context of the caller. If an exception occurs in a function module in this queue, this results in a short dump because the qRFC Manager cannot detect the exception in this session.

○       If you set the import parameter USERDEST to a "local" RFC destination (for example, a logical destination with NONE or SPACE as a reference destination) in transaction SM59, the qRFC Manager processes all qRFC LUWs in a queue under the user who is currently logged on. If no destination has been entered, or the user has not been defined, the current user is used.

 

See also RSTRFCI3.

 

TRFC_QIN_RESTART_COND

●      You use this function module if you specify a queue name, or a high priority queue name (single or generic, for example BASIS_TEST_*) for restarting one or more queues.

○       If you change the import parameter TILL_STOP to SPACE, the qRFC Manager restarts the queue as soon as this high priority queue is empty. Otherwise this queue is restarted as soon as it has been stopped or is empty.

○       If no other STOP call has been scheduled, calling this function using TILL_STOP = SPACE automatically ends the queue at the time of the call.

 

See also RSTRFCI4.

 

TRFC_QIN_SAVE_CURRENT_LUW

●      Informs the qRFC manager during execution of a function module that the current LUW is to be saved (for re-use) after it has been executed successfully.

 

TRFC_QIN_STATE

●      Use this function module to display the status of this queue if you specify the queue name and – optionally – the SAP client.

○       A queue has the following possible status displays: READY, CPICERR, SYSFAIL, STOP, WAITSTOP and WAITING.

○       The status SYSFAIL results from a serious system error, and is caused by a system exception or application exception while the current LUW is being processed in the target system. In this situation, the queue is blocked, and automatic restart is not possible. You can use the program RSTRFCI0 to reactivate the LUW, or use the program RSTRFCID to delete the qRFC LUW.

○       In status CPICERR, there is also no automatic retry. This error can only occur if the SAP Gateway on the local application server is out of order. Use RSTRFCI0to restart the queue after the Gateway problem has been resolved.

○       If the queue has the status WAITSTOP or WAITING, the exporting parameter WQNAMEdisplays which queue the current queue is waiting for before it is processed.

 

See also RSTRFCI2.

 

TRFC_QIN_STOP

●      You use this function if you specify a queue name to stop processing of one or more queues (single or generic, for example BASIS_TEST_*)

○       If the importing parameter FORCE is changed to SPACE, the qRFC Manager only processes LUWs that exist in the queue at STOP time. Otherwise, the qRFC Manager stops the processing immediately.

○       A STOPcounter counts the number of STOPcalls.

○       You can also stop an empty (non-existent) queue. In this situation, all the LUWs assigned to this queue are saved in the qRFC tables.

 

See also the program RSTRFCI1.

 

TRFC_QINS_DELETE_LUW

●      Deletes a LUW defined with import parameter TID in a stored inbound queue.

 

TRFC_QINS_DELETE_QUEUE

●      Deletes the entire inbound queue defined by import parameter QNAME.

 

TRFC_QINS_ERASE

●      Deletes some or all LUWs that were defined with import parameters QNAME and FROM_COUNT and which are saved.

 

TRFC_QINS_OVERVIEW

●      Gets an overview of the currently saved inbound queues.

 

TRFC_QINS_RESTORE

●      Restores some or all LUWs that were defined with import parameters QNAME and FROM_COUNT and which are saved.

 

TRFC_RECEIVER_INFO

●      Gets information from the sender of a tRFC or qRFC LUW, for example, TID, client, user, hostname of application server, program name, and transaction code. You can also use this function module to determine whether a function module has been sent by tRFC or qRFC with inbound queue.

 

TRFC_SET_QIN_PROPERTIES

●      Transfers an outbound queue name, inbound queue name and – optionally – a queue counter to the qRFC manager. These parameters are only valid for the next Call Function In Background Task. The outbound queue and the inbound queue can have the same queue name.

 

See also the program RSTRFCT5.