In this article

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.

Pre-requisites

Anti-virus requirements

To ensure the smooth functioning of the Snaplex node, we suggest disabling any anti-virus or firewall software, including the Windows firewall. If disabling the software cannot be done, ensure the anti-virus software does not scan the Snaplex process. The action required may vary depending on the type of antivirus software and scanning rules enabled. The following are the guidelines:

• Disable the network firewall functionality for the following ports: 8081, 8084, 8089, and 8090. Refer to the Required Ports section 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.

Required Ports

If another application already uses one of the JCC ports used by SnapLogic, the JCC nodes do not complete a full start cycle. The workaround is to override the default port by assigning the following entries in the global properties to available ports:

• For HTTP port: jcc.jetty_port = 8x89

• For HTTPS port: jcc.cc_secure_port = 8x81

Java Development Kit (JDK)

You must install Java Development Kit (JDK) before installing your on-premise Snaplex. The SnapLogic platform supports Java 11, and we recommend using the latest patch version available for Java 11 for your Windows environment. To update your Snaplex to Java 11, refer to Upgrading Your Groundplex to Java 11.

JDK11 Distribution

Only AdoptOpenJDK 11 (Adoptium) is certified by SnapLogic. As no other JDK 11 distribution is currently certified by SnapLogic, we recommend only using Adoptium's JDK when upgrading to Java 11. Select the appropriate Operating System, Architecture, Package Type, and Version from the Adoptium site and download the Zip file and then unzip the files to the appropriate directory.

File Name Length

File names generated by SnapLogic for suggested data can be longer than 260 characters long. We recommended that you configure the Snaplex node to allow longer file paths. Learn more at Maximum Path Length Limitation - Win32 apps for details.

Installing the Snaplex

1. Log into the SnapLogic Manager as an Org admin.

2. Under Project Spaces on the left, create a project space or locate the project where you want to create your Groundplex (or the global shared project). Select the Snaplexes tab on the right and click the icon to add a Snaplex.
   

   

    

3. Complete the details in the Create Snaplex dialog and click the Create button. (later seen as the Update Snaplex dialog in the application). 
   

   

4. The Update Snaplex dialog opens with the Downloads tab for selecting and installing the appropriate package for the operating system. Download the Windows/ ZIP configuration files onto the Windows machine where you want the Groundplex installed.
   

   

5. Create the directory \opt on your server in the root of the C: drive.

6. Unzip the zip file to c:\opt. This will create a directory c:\opt\snaplogic and a directory structure as follows:
   

   

7. After installing the software, move the Configuration file (you can get this from the Update Snaplex dialog) to the \opt\snaplogic\etc directory and ensure the file extension is .slpropz.

8. 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.
   

   

   1. If the installed version of Java is below JDK 11, download and install the JDK for Windows. The existing installation can be used if JRE 11 is available on the machine.

   2. Use any text editing software like Notepad to edit the file c:\opt\Snaplogic\bin\jcc.bat and change the entry for the JAVA_HOME environment variable to the location of the existing installation, putting double quotes around the value.
      

      

   3. If the host machine is configured for JDK auto-update, 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 avoid this issue, use the static installation feature of the JDK installer.  
      To do a static install:

      • Add the STATIC=1 option when running the JDK installer from the command line or from the Run dialog.

      • When the JRE auto-update occurs, uncheck the uninstall option for older JDK installations. This prevents the older installation from being removed. 
        

9. From the command prompt, change to the \opt\snaplogic\bin directory. You may start the node by running the command: jcc.bat start

10. To install Snaplex as a Windows service, run the following command as an administrator: jcc.bat install_service. From the Windows Control Panel, view the entry for the SnapLogic Snaplex, and start the service from Tools in the Services window.

11. To establish if the process started, run the command: jcc.bat status. The state should be Running.

12. To verify if the Snaplex has started, visit https://elastic.snaplogic.com/sl/dashboard.html#Health

13. The newly installed node should show up in the list of nodes for the Snaplex.

Upgrading on Windows

Updating Cygwin Binaries

When running the Windows-based Snaplex as a service, performing a service restart causes the Monitor process to start with the old binaries files. 

When upgrading your Snaplex to the latest version, you need to reinstall the Snaplex using the latest version of the installer zip file for Windows. Upgrading through the Manager will only upgrade the war file, not the binaries.  To update the service to use the latest binaries, you can choose from one of the two following options:

Option 1: Perform a complete reinstallation

1. Stop the Windows-based Snaplex service.

2. Remove using bin\jcc.bat remove_service.

3. Back up the configuration files from the \etc folder.

4. Remove C:\opt\snaplogic.
   

   

5. Reinstall the Windows-based Snaplex using the latest version zip file.

Option 2: Install the Latest Cygwin Binaries Only

1. Unzip the version zip into a different location.

2. Copy bin\cygwin1.dll and bin\cygrunsrv.exe from the new zip to the existing installation location.

3. Update and restart the service using bin\jcc.bat update_service.

Uninstall the SnapLogic Snaplex package from your environment

To uninstall the SnapLogic Windows-based package from your environment:

1. Stop the Snaplex service before uninstalling or installing the Snaplex elsewhere by using the following command.
   run 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.
   

   

If you are reinstalling a JCC node, stop the Snaplex service that is already installed.

Older Versions of JRE and TLS

JRE versions before 11.0.8 have issues connecting to TLS 1.3 endpoints. We recommend using an updated version of JRE.

Renabling Support for Older Versions

If updating the TLS endpoint is not possible, then the Snaplex JRE can be updated to re-enable support for older TLS versions by doing these steps:

1. Open the jre/conf/security/java.security file in the JRE installation folder that you configured during installation.

2. Change the jdk.tls.disabledAlgorithms configuration property by removing TLSv1, TLSv1.1.

3. Restart the Snaplex to re-enable support for TLS 1.0 and 1.1.

Renaming Snaplexes

1. In the Manager tab, navigate to the Shared or specific Project folder and click on the Snaplexes filter.

2. Select the Groundplex you wish to rename.

3. In the Groundplex Update dialog, change the name to your desired name and click the Update button. The change will immediately be visible in the Dashboard; however, in Designer, the drop-down box for pipeline design will reflect the old name for some time. Despite the difference in name in the Designer tab, the pipelines continue to validate or execute.

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.

   1. Add the Service Account user to the local Administrators group.

   2. 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

   1. Install as a service (C:\opt\snaplogic\bin\jcc.bat install_service)

4. From Windows Services

   1. Change login to the Service Account user

   2. Start the service

Learn more at Service Accounts | Microsoft Learn

FAQ

Troubleshooting

Reference

• Video: Installing Groundplex on Windows