Skip to Content

SAP Event Listener


The Jitterbit SAP Event Listener is a locally installed application that listens for IDocs that are outbound from SAP. Its configuration requires the use of the SAP Connector for Harmony Design Studio to configure an SAP IDoc Event as part of a Design Studio operation. Once the SAP Event Listener is fully configured, the IDocs that it receives trigger the Design Studio operation.


To use the SAP Event Listener, all prerequisites of the SAP Connector must be met, as described in Prerequisites in SAP Connector.

If following our recommendation to install the SAP Event Listener on a Private Agent, all prerequisites of a Private Agent must be met, as described in System Requirements for Private Agents.

These prerequisites specific to the SAP Event Listener must also be met:

  • The SAP system must be configured with an RFC destination, a transactional RFC (tRFC) port, and a partner profile for use by the Jitterbit SAP Event Listener.
  • The SAP Event Listener must be installed on a machine that meets these requirements:
  • The SAP Event Listener must be configured to use a Private Agent. We recommend installing the SAP Event Listener on the same machine as a Private Agent.
  • For the SAP Event Listener to have high availability, if there is more than one Private Agent in a Private Agent Group, an instance of the SAP Event Listener must be installed and configured in exactly the same way on each agent in the group.
  • If using SAP S/4HANA single-tenant, the SAP Event Listener version or later is required. (SAP ECC is supported with no minimum version number.)
  • Design Studio version or later is required to configure and use the SAP Event Listener.

Get Started

The SAP Event Listener Get Started Guide provides a summary and recommended order of installation and configuration steps to start using the SAP Event Listener, as well as a description of how Harmony and the SAP Event Listener process IDoc events.

Supported RFC Protocols

The SAP Event Listener supports the transactional RFC (tRFC) and queued RFC (qRFC) protocols:

  • Transactional RFCs
    • A tRFC function call is executed exactly once in the target system.
    • The system checks if a TID (unique transaction identifier) has already been processed. If it has, the tRFC function call is ignored.
    • If the target system is not available when the call is made, the SAP Connector continues to retry to process the transaction. The SAP Connector also continues to process other tRFC function calls.
    • The order in which the tRFC function calls are processed is not guaranteed.
  • Queued RFCs
    • Each qRFC function call is placed in an outbound queue that is processed in a specific order.
    • A qRFC function call cannot be executed until all of its predecessors in the queue have been processed. A qRFC function call is transferred only if it has no predecessors in the participating queue.
    • After a qRFC function call is executed, the system attempts to start the next qRFC transaction in the sequence from the queue.
    • A queue name and a queue counter are required for each qRFC transaction for queue administration. Each qRFC call that is to be processed chronologically is assigned a queue name.

Known Issue

The latest version of the SAP Event Listener has this known issue:

  • SAP Event Listener: The Windows configuration UI cannot be opened

    • Summary: On attempting to open the Windows SAP Event Listener configuration through the UI, an exception occurs.

    • Additional Information: This issue occurs when a previously saved configuration that includes the required outer set of <events> and </events> tags in the Event Details field has since been inadvertently saved without those tags.

    • Recovery: Manually edit the configuration file at C:\ProgramData\JitterbitSAPEventListener\conf\sapeventconfig.xml to replace the required outer tags. The Windows configuration UI can again be opened.