Show TOC

Syntax documentationqRFC API for the Outbound Queue Locate this document in the navigation structure

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

TRFC_GET_QUEUE_INFO and TRFC_GET_QUEUE_INFO_DETAILS

  • Reads the current contexts of one or all outbound queues. For more information, see the example program RSTRFCQR.

TRFC_QUEUE_INITIALIZE

  • Informs the qRFC-Manager that you are working with tRFC and qRFC in a LUW (Mixed Mode) and that the first call is a tRFC call.

TRFC_QOUT_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. Only use this function if the queue is blocked due to a communication or network error, or if a system or application exception has occurred and the problem has already been solved.

  • A queue that has been stopped (by calling the function TRFC_QOUT_STOP) cannot be processed with this function.

    • If the importing parameter FORCE is changed to ’, the qRFC Manager resends the LUW, even if it is in the status EXECUTING. This parameter setting is only intended for system programs. under normal conditions, you do not need this function because the qRFC manager automatically tries to solve such blockages. See also the program RSTRFCQ0.

TRFC_QOUT_DELETE_LUW

  • Deletes the LUW in an outbound queue that was defined with import parameter TID.

TRFC_QOUT_DELETE_QUEUE

  • Deletes the entire queue that was defined with import parameters QNAME and DEST.

TRFC_QOUT_GET_AND_PROCESS

  • Reads qRFC LUWs from the outbound queue in the local or remote SAP system.

    • If you use the SINGLE_PROCESSING parameter, the qRFC Manager sends an error code and an error message to the calling system if a system or application exception occurs when processing a LUW. All successfully processed LUWs in the outbound queue are deleted. The qRFC LUW with errors stays in the outbound queue.

    • If you do not use SINGLE_PROCESSING parameter, a system or application exception causes a short dump and all LUWs to be read remain in the outbound queue. They can be reread and processed at a later time.

TRFC_QOUT_GET_CURRENT_QUEUES

  • Shows all current existing queues.

TRFC_QOUT_GET_ERROR_QUEUES

  • Displays all queues with errors that are blocked because of one of the following error messages: SYSFAIL, CPICERR, RETRY, ARETRY, ANORETRY.

    • Queues that have the status WAITING are not displayed.

TRFC_QOUT_GET_FIRST_LUW

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

TRFC_QOUT_GET_HANGING_QUEUES

  • Displays all blocked queues, including the queues that the application has explicitly written in the queue for later processing and have the status WAITING.

    Caution Caution

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

    End of the caution.
TRFC_QOUT_OVERVIEW

  • You use this function module for an overview of the current outbound queues that exist for various optional import parameters, for example, queue name, destination, SAP client.

TRFC_QOUT_RESTART

  • You use this function module if you want to specify a queue name (single or generic, for example BASIS_TEST_*) and a destination to continue the processing of one or more queues, regardless of whether the queue has already been stopped.

    • If you change the FORCE import parameter to SPACE, the qRFC manager reduces the STOP counter. If the counter is on 0, it activates the queue. Otherwise, the qRFC Manager always activates the queue regardless of the STOP counter.

    • If a queue is blocked, use the above call and not TRFC_QOUT_ACTIVATE.

    • If you set the importing parameter NO_ACTIVATE to ’, the qRFC Manager unlocks the queue, but does not activate it. See also the program RSTRFCQ3..

TRFC_QOUT_RESTART_COND

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

    • 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.

      Note Note

      See also the programs RSTRFCQ4 (till_stop = space) and RSTRFCQA (till_stop= 'X').

      End of the note.
TRFC_QOUT_STATE

  • You use this function module when you enter a queue name, a destination, and optionally an SAP client, to display the status of the queue.

    • In status CPICERR, the automatic repetition of the queue depends on the configuration of the destination in SM59 (default setting is Yes).

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

    • The difference between the status NOSEND and NOSENDS is that a queue with the status NOSENDS can be activated and restarted using SMQ1, or the appropriate function module. Queues with the status NOSEND can only be read using other systems or programs.

      Note Note

      See also the program RSTRFCQ2.

      End of the note.
TRFC_QOUT_STOP

  • Stops the processing of one or more queues while you specify a queue name (single or generic, for example BASIS_TEST_*) and a destination.

    • 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 transaction immediately.

    • The STOP counter counts the number of STOP calls for a queue.

    • You can also stop an empty (non-existent) queue. In this situation, all the LUWs that are assigned to this LUW are stored in the queue. See also the program RSTRFCQ1.

TRFC_SET_BACKGROUND_SEQUENCE

  • Determines the processing sequence of qRFC LUWs that have been called from a dialog task and an update task in a transaction.

TRFC_SET_QUEUE_NAME

  • Transfers a queue name to the qRFC Manager. This queue name is valid for the next Call Function ... In Background Task..

  • If the import parameter NOSEND has been set to ‘X’or ‘S’, the qRFC Manager does not send the LUW at Commit Work time, but saves it in the qRFC table instead.

    • 'S': This LUW can be restarted from SMQ1 (or other function modules).

    • 'X': 'X': This LUW can only be processed by one application program. It cannot be processed using the QOUT Scheduler.

    • This parameter applies for the whole LUW.

TRFC_SET_QUEUE_NAME_LIST

  • Transfers a queue name to the qRFC Manager if Call Function ... In Background Task was assigned to more than one send queue. You can use this function module together with TRFC_SET_QUEUE_NAME in one LUW.

  • If the import parameter NOSEND has been set to ‘X’or ‘S’, the qRFC Manager does not send the LUW at Commit Work time, but saves it in the qRFC table instead.

    • 'S': This LUW can be restarted from SMQ1 (or other function modules).

    • 'X': 'X': This LUW can only be processed by one application program. It cannot be processed using the QOUT Scheduler.

    • This parameter applies for the whole LUW.

TRFC_SET_QUEUE_RECEIVER_LIST

  • Transfers a queue name to the qRFC Manager if the function called by Call Function ... In Background Task is to be processed in different target systems. The qRFC Manager stores all the data for this qRFC only once in the database.

  • You also need to set the options AS SEPARATE UNIT and DESTINATION as importing parameters for this function.

  • If the import parameter NOSEND has been set to ‘X’or ‘S’, the qRFC Manager does not send the LUW at Commit Work time, but saves it in the qRFC table instead.

    • 'S': This LUW can be restarted from SMQ1 (or other function modules).

    • 'X': 'X': This LUW can only be processed by one application program. It cannot be processed using the QOUT Scheduler.

    • This parameter applies for the whole LUW.

      Caution Caution

      This function module cannot be used together with either of the function modules described above in one LUW.

      End of the caution.