Installation of the Jitterbit Design Studio SAP Event Listener

Introduction

Prior to installing the SAP Event Listener application, review the Prerequisites in SAP event listener.

Complete these steps to install the SAP Event Listener, as detailed on this page:

1. Downloading required components
2. Install required components
3. Downloading the SAP event listener
4. Installing the SAP event listener

During the SAP Event Listener installation process, you are prompted to configure the SAP Event Listener application. Complete the configuration of the SAP Event Listener as described in SAP event listener configuration during or after installation. Once installed, the SAP Event Listener runs as a service.

These activities are also covered on this page:

• Upgrading the SAP event listener
• Restarting the SAP event listener service

For all steps required to configure and use the SAP Event Listener, see SAP event listener get started guide.

Downloading required components

On each machine where the SAP Event Listener is to be installed, certain files must be present and installed before the SAP Event Listener itself is installed.

Use these SAP Support Portal download links to obtain the specific files required by SAP Event Listener. This table summarizes the files needed. The following subsections provide details on where the required files can be found within the downloaded archives.

A later section, Install required components, describes where those files should be placed before the SAP Event Listener installation.

The required component filenames, once installed, must exactly match those listed above.

SAP Java connector files for Windows

1. Go to the section Download SAP Java Connector 3.1 SDK on the SAP Java Connector page.

2. In the table of downloads, use the link for the 64-bit x86* version for Microsoft Windows and Windows Server to download a ZIP file. The ZIP file is named similarly to sapjco31P_4-20009381-Windows.zip. Unpack the archive.

3. Within the unpacked archive, locate another ZIP file, named similarly to sapjco3-ntamd64-3.1.4.zip. Unpack the archive.

4. Within the newly unpacked archive, locate sapjco3.dll and sapjco3.jar.

SAP Java connector files for Linux

1. Go to the section Download SAP Java Connector 3.1 SDK on the SAP Java Connector page.

2. In the table of downloads, use the link for the 64-bit x86* version for Linux for Intel compatible processors to download a ZIP file. The ZIP file is named similarly to sapjco31P_4-70004517-Linux.zip. Unpack the archive.

3. Within the unpacked archive, locate the TGZ file, named similarly to sapjco3-linuxx86_64-3.1.4.tgz. Unpack the archive.

4. Within the newly unpacked archive, locate the TAR file, named similarly to sapjco3-linuxx86_64-3.1.4.tar. Unpack the archive.

5. Within that newly unpacked archive, locate libsapjco3.so and sapjco3.jar.

SAP Java IDoc library

1. Go to the section SAP Java IDoc Library on the SAP Java Connector page.

2. Use the link Download SAP Java IDoc Library ... SDK to download a ZIP file. The ZIP file is named similarly to sapjidoc30P_14-10009485.zip. Unpack the archive.

3. Within the unpacked archive, locate sapidoc3.jar.

Install required components

A user with access to each machine where the SAP Event Listener is to be installed can install the required components on Windows or Linux machines using the instructions below.

Windows

Follow these steps to install the required components for the SAP Event Listener on a Windows machine.

1. Create a new directory in <HOME> named Jitterbit SAP Event Listener:

   C:\Program Files\Jitterbit SAP Event Listener
   

2. Within the newly created directory, create two sub-directories named bin and ui:

   C:\Program Files\Jitterbit SAP Event Listener\bin
   

   C:\Program Files\Jitterbit SAP Event Listener\ui
   

3. Copy the DLL file to the Jitterbit SAP Event Listener bin directory:

   C:\Program Files\Jitterbit SAP Event Listener\bin\sapjco3.dll
   

4. Copy the JAR files to the Jitterbit SAP Event Listener ui directory:

   C:\Program Files\Jitterbit SAP Event Listener\ui\sapidoc3.jar
   
   C:\Program Files\Jitterbit SAP Event Listener\ui\sapjco3.jar
   

Linux

Follow these steps to install the required components for the SAP Event Listener on a Linux machine.

1. Create a new directory in /opt named jitterbitsap:

   # mkdir /opt/jitterbitsap
   

2. Within the newly created directory, create two sub-directories named bin and ui:

   # mkdir /opt/jitterbitsap/bin
   
   # mkdir /opt/jitterbitsap/ui
   

3. Copy the SO file from the download location to the Jitterbit SAP Event Listener bin directory (adjust source name as required):

   # cp /home/<USERNAME>/Downloads/libsapjco3.so /opt/jitterbitsap/bin
   

4. Copy the JAR files from the download location to the Jitterbit SAP Event Listener ui directory (adjust source name as required):

   # cp /home/<USERNAME>/Downloads/sapidoc3.jar /opt/jitterbitsap/ui/sapidoc3.jar
   
   # cp /home/<USERNAME>/Downloads/sapjco3.jar /opt/jitterbitsap/ui/sapjco3.jar
   

Downloading the SAP event listener

A Harmony user can download the SAP Event Listener from the Harmony portal downloads page. The Windows download is an executable installer in EXE file format. The Linux download is an archive in tar file format.

The SAP Event Listener files are located at the bottom of the page under the Jitterbit Connectors section:

Installing the SAP event listener

After installing the required components and downloading the SAP event listener, a user with access to each machine where the SAP Event Listener is to be installed should use these instructions to install the SAP Event Listener.

Windows

Open the executable installer and follow the steps of the InstallShield Wizard:

1. In the welcome dialog, click Next:

   

2. In the Customer Information dialog, you can leave the input fields blank as this information is not required. Click Next:

   

3. In the Destination Folder dialog, select the Jiterbit SAP Event Listener folder where you installed required components (see Install required components). Click Next:

   

4. In the Ready to Install the Program dialog, click Install:

   

5. The SAP Event Configurations dialog opens. For configuration instructions, see SAP event listener configuration:

   

6. After the SAP Event Listener is configured, restart the service as described in Restarting the SAP event listener service later on this page.

Linux

Installation of the SAP Event Listener on Linux is completed using the command line using superuser permissions:

1. Extract the tar file to the jitterbitsap folder where you installed the required components (see Install required components):

   # tar -xvf JitterbitSAPEventListener-8.29.2.4.tar -C /opt/jitterbitsap
   

2. Change directories to the bin sub-directory:

   # cd /opt/jitterbitsap/bin
   

3. Configure the SAP Event Listener as described in SAP event listener configuration:

   # ./runconfig.sh
   

4. After the SAP Event Listener is configured, restart the service as described in Restarting the SAP event listener service later on this page.

Upgrading the SAP event listener

Follow these steps to upgrade the SAP Event Listener to a later version.

Windows

The SAP Event Listener cannot be upgraded directly from a prior version. Instead, it must first be uninstalled and then the new version installed:

1. Copy the previously downloaded and installed SAP JCo files to another location to reuse later during reinstallation of the SAP Event Listener. These files are located in the Jitterbit SAP Event Listener bin and ui directories:

   C:\Program Files\Jitterbit SAP Event Listener\bin\sapjco3.dll
   

   C:\Program Files\Jitterbit SAP Event Listener\ui\sapidoc3.jar
   
   C:\Program Files\Jitterbit SAP Event Listener\ui\sapjco3.jar
   

2. Make a backup of the SAP Event Listener directory, located here:

   C:\ProgramData\JitterbitSAPEventListener
   

3. Uninstall any prior versions of the SAP Event Listener. This can be done under Settings > Apps & Features:

   

4. Follow Install required components using the SAP JCo files that you copied in step 1 above.

5. Follow Downloading the SAP event listener to obtain the latest version of the SAP Event Listener.

6. Follow Installing the SAP event listener. When the SAP Event Configurations dialog opens, click Save to complete the installation process.

7. Place the SAP Event Listener directory that you copied in step 2 above into this location:

   C:\ProgramData\JitterbitSAPEventListener
   

8. Access the SAP event listener configuration to confirm the settings or to make any further changes as desired. For configuration instructions, see SAP event listener configuration.

9. Restart the SAP Event Listener service as described in Restarting the SAP event listener service.

Linux

The SAP Event Listener cannot be upgraded directly from a prior version. Instead, it must first be uninstalled and then the new version installed:

1. Copy the previously downloaded and installed SAP JCo files to another location to reuse later during reinstallation of the SAP Event Listener. These files are located in the Jitterbit SAP Event Listener bin and ui directories (adjust source names as required):

   # cp /home/<USERNAME>/Downloads/libsapjco3.so /opt/jitterbitsap/bin
   

   # cp /home/<USERNAME>/Downloads/sapidoc3.jar /opt/jitterbitsap/ui/sapidoc3.jar
   
   # cp /home/<USERNAME>/Downloads/sapjco3.jar /opt/jitterbitsap/ui/sapjco3.jar
   

2. Make a backup of the SAP Event Listener directory, located here:

   /opt/jitterbitsap/data/JitterbitSAPEventListener
   

3. Run this command to stop the SAP Event Listener:

   # ./shutdown.sh
   

4. Uninstall by deleting the install pathway:

   # rm -rf /opt/jitterbitsap
   

5. Follow Install required components using the SAP JCo files that you copied in step 1 above.

6. Follow Downloading the SAP event listener to obtain the latest version of the SAP Event Listener.

7. Follow Installing the SAP event listener but do not yet run the configuration script.

8. Place the SAP Event Listener directory that you copied in step 2 above into this location:

   /opt/jitterbitsap/data/JitterbitSAPEventListener
   

9. Access the SAP event listener configuration to confirm the settings or to make any further changes as desired. For configuration instructions, see SAP event listener configuration.

10. Restart the SAP Event Listener service as described in Restarting the SAP event listener service.

Restarting the SAP event listener service

Follow these steps to restart the SAP Event Listener service.

Windows

1. Use the Windows start menu to locate the Jitterbit SAP Event Listener:

   

2. Select Stop Jitterbit SAP Listener to stop the SAP Event Listener service.

3. Select Start Jitterbit SAP Listener to start the SAP Event Listener service.

Linux

1. Stop the SAP Event Listener using this command:

   # ./shutdown.sh
   

2. Start the SAP Event Listener using this command:

   # ./startup.sh
   

   Output similar to this is displayed:

   Using CATALINA_BASE:   /opt/jitterbitsap
   
   Using CATALINA_HOME:   /opt/jitterbitsap
   
   Using CATALINA_TMPDIR: /opt/jitterbitsap/temp
   
   Using JB_JRE_HOME:        ..//jre
   
   Using CLASSPATH:       /opt/jitterbitsap/bin/bootstrap.jar:/opt/jitterbitsap/bin/tomcat-juli.jar
   
   Tomcat started.