How to install the OS Wrapper

This article describes the process for installing and uninstalling the GTD adapter for SAP as an OS service on the Windows operating system. 

Only Windows users can use the OS wrapper and installing it is optional. 

Before installing the OS wrapper

The adapter can always be started at the command line. Using the wrapper creates a Windows service that ensures that the adapter restarts whenever the Windows computer is restarted. 

This configuration requires that you obtain a Java Service Wrapper tool, as it’s not part of the Global Tax Determination SAP adaptor installation kit with the Global Tax Determination adapter for SAP. 

You can use this third-party wrapper tool. Other wrapper tools are also available and compatible with the SAP adapter.

 

Installing the OS Wrapper

Copy the wrapper files 

The following table lists the folders where the wrapper files will be copied on the different supported application services. 

 

Name Example Function
wrapper.exe  Sovos-S4Hana-JcoServer\  Used to install and uninstall the adapter as a service.
wrapper.dll  Sovos-S4Hana JcoServer\sapservicewrap per\wrapperlib\ Create this folder. It’s the native library required by the portion of the wrapper which runs within the JVM.
wrapper.jar  Sovos-S4Hana JcoServer\sapservicewrap per\wrapperlib\ Contains all wrapper classes.
wrapper.conf Sovos-S4Hana JcoServer\sapservicewrap per\conf\ It’s the configuration file used by wrapper.exe. It holds various settings for the JVM, log file, Windows, and SAP Adapter.

Set up the environment 

    1. Go to My Computer > Properties > Advanced > Environment Variables. 
    2. Under System Variables, click New to display the New System Variable box.
    3. In the Variable Name field, enter ‘JAVA_HOME’. 
    4. In the Variable Value field, enter the directory path for the JDK. 
    5. Click OK.

      The wrapper can be used with JDK 1.6 (GTD Hosted), JDK 1.7 (GTD  Premise), or later. If an underlying adapter is using a later version, make sure to use that same version. The Wrapper uses the JDK to install or uninstall the adapter as a service. 

    6. Create another new system variable by repeating step 2. 
    7. In the Variable Name field, enter ‘SAPJCO_HOME’. 
    8. In the Variable Value field, enter the directory path for the SAPJco. 
    9. Click OK. 
    10. Click OK, then click Apply. 

      Version 3.0.21 of the SAP JCo files is required for adapter use. 

Install SAP adapter as a startup service 

    1. Open a DOS window. 
    2. Go to the appropriate installation folder. 
    3. To install the adapter as a Windows service, execute the command SAPServiceWrapper-Install.bat 

Uninstall SAP adapter as startup service 

    1. Stop the service. 
    2. Open a DOS window. 
    3. Go to the appropriate installation directory. 
    4. To uninstall the adapter as a Windows service, execute the command SAPServiceWrapper-Uninstall.bat

Start and stop service 

    1. Start the service manually after the initial installation. The service will start automatically after the system startup if the Startup Type is set to Automatic. 

      If you are not using Windows you will need to implement OS-specific procedures for starting/stopping the adapter. 

Start, stop, and restart service using the Windows service manager 

    1. Go to Control Panel > Administrative Tools > Services. 
    2. Locate and select the service, GTD SAP On-Prem adapter 9.1.0, from the Name column. 
    3. Select an appropriate action to start, stop or restart the service. 

Change service name 

    1. Stop the service (if running). 
    2. Uninstall the service by executing SAPServiceWrapperUninstall.bat from the appropriate installation directory. 
    3. Set the appropriate value for the following properties and reinstall the service by executing SAPServiceWrapper-Install.bat. 
      1.  wrapper-ntservice.name 
      2.  wrapper-ntservice.displayname 
      3.  wrapper.ntservice.description 

Change value of JAVA_HOME or SAPJCO_HOME 

    1. Stop the service (if running). 
    2. Update the JAVA_HOME or SAPJC_HOME environment variable with the new value. 
    3. Restart the service.