Sovos Docs

Install the OS Wrapper

This article describes the process for installing and uninstalling the Tax Determination connector for SAP as an OS service on the Windows operating system.

  • You will need a Java Service Wrapper tool, as it is not part of the Tax Determination SAP connector installation kit. You can use any wrapper tool that is compatible with the SAP connector.
Note: Only Windows users can use the OS wrapper and installing it is optional.

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

  1. Copy the wrapper files.
    The following table lists the folders where the wrapper files will be copied on the supported application services.
    NameExampleFunction
    wrapper.exe Sovos-S4Hana-JcoServer\ Used to install and uninstall the adapter as a service.
    wrapper.dll Sovos-S4Hana JcoServer\sapservicewrap per\wrapperlib\ You need to 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.confSovos-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 connector.
  2. Set up the environment.
    1. Right-click My Computer and select Properties.
    2. On the Advanced tab, select Environmental Variables.
    3. In the System Variables section, click New.
    4. In the New System Variable dialog, enter JAVA_HOME in the Variable Name field and enter the directory path for the JDK in the Variable Value field.
    5. Click OK.
      Note:

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

    6. Optional: Create another new system variable by repeating sub-step b.
    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.
      Note:

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

  3. Install the SAP connector as a startup service.
    1. Open a DOS window.
    2. Go to the appropriate installation folder.
    3. To install the connector as a Windows service, execute the command SAPServiceWrapper-Install.bat.
  4. Uninstall the SAP connector as a startup service.
    1. Stop the service.
    2. Open a DOS window.
    3. Go to the appropriate installation directory.
    4. To uninstall the connector as a Windows service, execute the command SAPServiceWrapper-Uninstall.bat.
  5. Start and stop service.
    1. Start the service manually after the initial installation.
    2. Set the Startup Type to Automatic and the service will automatically start after the system startup.
      Tip:

      If you are not using Windows, you need to implement OS-specific procedures for starting or stopping the connector.

  6. Start, stop, and restart service using the Windows service manager.
    1. Go to Control Panel > Administrative Tools > Services.
    2. Locate and select the service Tax Determination SAP On-Prem connector 9.1.0 from the Name column.
    3. Select the appropriate action to start, stop, or restart the service.
  7. 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

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