During the SAP Event Listener installation process, you are prompted to configure the SAP Event Listener.
You can also reconfigure the SAP Event Listener after the installation process is complete. When reconfiguring the SAP Event Listener, it is recommended to restart the service after configuration (see Restarting the SAP Event Listener Service in SAP Event Listener Installation).
These activities related to configuring the SAP Event Listener are detailed on this page:
- Accessing the SAP Event Listener Configuration
- Entering Input into the SAP Event Listener Configuration
- Adding the Gateway Port to the Services File
- Testing the Connection and Verifying the Service is Running
As described later on this page, when configuring the SAP Event Listener for the first time, you will not yet be able to complete the Event Details portion of the configuration. Instead, you can leave this portion of the configuration empty until you have obtained the necessary input for this field. The necessary input is generated as described in Creating an SAP IDoc Event Operation and Obtaining Event Details in SAP Event Listener Design Studio Configuration and Use.
For the recommended order of all steps required to configure and use the SAP Event Listener, see the SAP Event Listener Getting Started Guide.
Accessing the SAP Event Listener Configuration
The method by which you access the SAP Event Listener configuration depends on whether the SAP Event Listener is installed on Windows or Linux. As the configuration fields are similar for both Windows and Linux, they are described together in the next section, Entering Input into the SAP Event Listener Configuration.
Configuration of the SAP Event Listener is done through the SAP Event Listener configuration screen.
To return to the configuration screen after initial configuration, use the Windows start menu to locate the Jitterbit SAP Event Listener and select Configure Jitterbit SAP Listener:
The SAP Event Configurations screen is displayed:
As an alternative to entering the configuration graphically, you can manually edit the SAP Event Listener configuration file at this location:
Configuration of the SAP Event Listener is done by executing a shell script on the command line. Change directories to the appropriate location and then run the script:
The script steps through the initial configuration fields where you provide input to configure the SAP Event Listener:
As an alternative to entering the configuration using the script, you can manually edit the SAP Event Listener configuration file at this location:
Entering Input into the SAP Event Listener Configuration
This section provides definitions of the SAP Event Listener configuration fields for Windows or Linux.
SAP Connection Properties
These fields are used to supply basic properties of the SAP endpoint:
- SAP Version: Select ECC or S4 HANA as the version of the SAP system. Though this setting is unavailable in the Linux version, both ECC and S4 HANA are supported without needing to specify the version.
- Username: Enter the username for the SAP system.
- Password: Enter the password for the SAP system.
- Client: Enter the numeric client ID associated with the SAP system.
- Language: Enter the language code for the language in which SAP messages should be sent, such as en for English.
- Router: If the SAP system is protected by a firewall, enter the router string required to connect to it. This setting is not supported in the Linux version.
Complete these fields if the SAP endpoint has a direct server connection. As settings for only either a direct connection or a load balancer connection can be configured for the Windows version, these fields are not used if the fields as listed under Load Balancer Connection below are also completed.
Application Host: Enter the SAP application server host name.
System Number: Enter the SAP system number.
Load Balancer Connection
Supported in the Windows version only, complete these fields if the SAP endpoint processes requests through a load balancer. As settings for only either a direction connection or a load balancer connection can be configured, these fields are not used if the fields listed under Direct Connection above are also completed.
MSHost: Enter the SAP message server host name.
MSPort: Enter the SAP message server port.
Group Name: Enter the SAP group name of the application servers.
System ID: Enter the SAP system ID.
SAP Event Connection Properties
These fields are used to configure the SAP Event Listener connection:
- Gateway Host: Enter the gateway host.
- Gateway Service: Enter the gateway service.
- Listener Count: Enter the number of listener threads that you want to run as part of this listener service, depending on your throughput requirements. The default is
Event Details: Enter the details of each IDoc event (tRFC and qRFC). Note, depending on whether you are using the Windows or Linux version of the SAP Event Listener:
Windows: During the initial SAP Event Listener configuration, you can leave the Event Details empty if you have not generated these details yet.
Linux: During the initial SAP Event Listener configuration, the shell script does not prompt you to provide event details. Instead, once you have generated the event details, you must manually add them to the configuration XML file, located at:
These details must be generated for each SAP IDoc Event operation created in Jitterbit Harmony Design Studio. After completing Creating an SAP IDoc Event Operation and Obtaining Event Details in SAP Event Listener Design Studio Configuration and Use, enter the details of each IDoc event here. When entering the details, note:
The entire input of this field must be enclosed within a set of outer
Within that outer set of tags, each event must be enclosed within a set of
You can enter both tRFC and qRFC events.
CAUTION: The Event Details field currently 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 Info: This issue occurs when a previously saved configuration that includes the required outer set of
</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.xmlto replace the required outer tags. The Windows configuration UI can again be opened.
- URL: The prepopulated SAP Event Listener URL. If following our recommendation to install the SAP Event Listener on each Private Agent in a Private Agent Group, the input in this field does not need to be modified. If installing the SAP Event Listener on a machine different from that where the Private Agent is installed, contact Jitterbit Support.
Adding the Gateway Port to the Services File
On each machine where the SAP Event Listener is installed, the SAP gateway port must be present in the operating system's
services file. If using the default SAP gateway port (3300), the port may or may not already be present in the
services file is located at these directory paths:
SAP ports begin with 31, 32, or 33, followed by a two-digit system number.
The default SAP gateway port begins with 33, followed by 00 as the gateway number. That is, the default SAP gateway port is 3300. If present, the default SAP gateway port is represented in the
services file by this entry:
If the default gateway port entry is missing from the
services file, or if the gateway port is different from the default, you must add it to the
services file. For example, if the gateway number is 17, then add a gateway port of 3317 to the services file:
Testing the Connection and Verifying the Service Is Running
After confirming that the gateway port has been added to the operating system's
services file, perform a test of the connection to validate the inbound communication with SAP and verify that the SAP Event Listener service is running. The service should be running even if the Event Details portion of the SAP Event Listener configuration has not yet been completed.
On Windows, in the SAP Event Listener configuration screen, click the Test Connection button. A dialog should indicate that the connection was successful:
Check that the Jitterbit SAP Event Listener service is running in Windows Services:
On Linux, testing the connection is the last step of the configuration script. When prompted to test the connection, enter y:
Output similar to this for a successful connection test is displayed:
Check that the SAP Event Listener service is running using
ps -ef :
Output similar to this is displayed:
You can also troubleshoot by tailing the
catalina.out log file:
Output similar to this is displayed: