Install a Groundplex on Windows

Overview

This article describes the procedures for installing an on-premise Snaplex, a Groundplex, in a Windows environment. This document uses the term Groundplex to distinguish this Snaplex (on-premise) type from a Cloudplex, which SnapLogic manages. However, in command syntax and references to the UI, the generic term Snaplex is used.

  • Hardware and OS requirements
  • Network requirements
  • Load balancer requirements
  • Environment (Org) admin permissions
  • Java Development Kit (JDK): Java 11
    Note: SnapLogic recommends upgrading to Java 11 using AdoptOpenJDK 11 (Adoptium), which is the only JDK 11 distribution that is currently certified by SnapLogic.

    Use the latest patch version available of Java 11 for your Windows environment.

    Important: Use the static installation feature of the JDK installer.

    Details

    If the host machine is configured to auto-update JDK, then each time a JDK update occurs, the older JRE installation is deleted by default. As a result, the Snaplex fails to start after the JDK update.

    To perform a static install, you can do one of the following:
    • Add the STATIC=1 option when running the JDK installer from the command line or from the Run dialog.
    • When the JDK auto-update occurs, uncheck the uninstall option for older JDK installations. This prevents the older installation from being removed.

    To verify that you have Java installed, run the following at the command line: java -version

    Learn more: Configuring the Java Version on your Groundplex

  • Antivirus and firewall software must be disabled.

    Details

    We recommend you disable any anti-virus or firewall software (including Windows firewall) installed on the Snaplex node. If you cannot disable the software, then ensure that the Snaplex process is not scanned by the anti-virus. The specific action depends on the antivirus software type and scanning rules enabled.

    Guidelines:
    • Disable the network firewall functionality for the following ports: 8081, 8084, 8089, and 8090. See the Required Ports requirement for more information about workarounds for other applications using the required ports.
    • Disable filesystem scanning for the c:\opt\snaplogic folder.
    • Disable process-level scanning for the SnapLogic service.
  • Previously installed Snaplexes must be stopped and the service removed.

    Details

    • To stop the old installation, run bin\jcc.bat stop.
    • If the Snaplex was installed as a service, run bin\jcc.bat remove_service.

Install the Snaplex

  1. Download the Groundplex installation files from the project you want to associate with the Groundplex.
  2. Create the directory c:\opt on your server in the root of the C: drive.
  3. Unzip the Windows ZIP file to c:\opt. This will create the directory c:\opt\snaplogic with a set of folders in it.
  4. Check your Windows environment to see if you have Java 11 version. This can be done by executing the command java -version from the command window.
  5. Open c:\opt\Snaplogic\bin\jcc.bat in a text editor.
  6. In c:\opt\Snaplogic\bin\jcc.bat, replace the value of JAVA_HOME with the correct path to your Java installation.
  7. Example: set JAVA_HOME="C:\Program Files\Java\jdk11.0.5_8"
  8. Copy the downloaded configuration file to c:\opt\snaplogic\etc
Important: The file extention must be slpropz. Example: mysnaplex.slpropz

Start the JCC node.

To start the JCC node as a regular service,

  1. Open a command prompt and run the following: 
     cd /d c:\opt\Snaplogic\bin\jcc.bat
jcc.bat start
  2. Verify that the service started. 
     cd /d c:\opt\Snaplogic\bin\jcc.bat
jcc.bat status

To start the JCC node as a Windows service,

  1. Open a command prompt as administrator and run the following: 
     cd /d c:\opt\Snaplogic\bin\jcc.bat
jcc.bat install_service
  2. Open the Windows Services app.
  3. In the list of services, search for the SnapLogic Snaplex service.
  4. Right-click on the SnapLogic Snaplex service and select Start.
  5. Verify that the service started by checking that the Status column says Running.

Uninstall the Snaplex from your environment.

  1. Stop the Snaplex service before uninstalling or installing the Snaplex elsewhere by using the following command: bin\jcc.bat stop.
  2. If Snaplex is installed as a service, the service needs to be removed by running the command bin\jcc.bat remove_service.
  3. Clean up the directory \opt on your server in the root of the C: drive.
  4. If you are reinstalling a JCC node, stop the Snaplex service that is already installed.

Groundplex - Windows Service Account Settings

  1. Create an Active Directory Service Account User and provide the required permissions on the network objects on the Groundplex.
  2. Set the Service Account user to be able to run the Snaplogic Snaplex service.
    • Add the Service user to the local Adminstrators group.
    • Add the Service Account user to Windows Administrative Tools > Local Security Policy > Local Policies > User Rights Assignment > Log on as a service.
  3. From Command Prompt as Administrator
    • Install as a service C:\opt\snaplogic\bin\jcc.bat install_service
  4. From Windows Services
    • Change login to the Service Account user
    • Start the service

Troubleshooting

Errors while starting the JCC node.

The user account used to start the Snaplex is changed or the Snaplex was previously started as an application and now is being started as a service.

Delete the following folders:
  • run\log
  • run\fs
  • run\broker

Insufficient user permissions

Verify that you're starting the JCC node as an administrator.

Java is not found.

Verify that the environment variable JAVA_HOME is set correctly.

The c:\opt\snaplogic\run\log folder is full.

Delete the logs and try again.

The Groundplex deployed on Windows 2022 has stopped running.

Groundplex on a Windows 2022 Server.

Windows 2022 server is supported for Groundplexes.