Service Deployment (Windows Only)

You can deploy 1Integrate as a service through additional configuration and by running two scripts supplied in the installation package.

     Warning: The absolute path of the installation directory must not contain a space (for example, C:\Program Files\1Spatial\1Integrate). This will cause a service-specific error and prevent the service from starting.

JAVA_HOME

Before running your start-up scripts, you must first ensure your deployment is configured to refer to the correct version of Java. For the Java version supported for your release of 1Integrate, please refer to the release notes.

Once you are sure you have the correct version of Java installed, you will need to ensure that the JAVA_HOME variable is defined.

     Note: If the JAVA_HOME variable is already defined on your system with the correct version of Java, then you do not need to do anything. We recommend that the JAVA_HOME environment variable is set as a system environment variable to ensure that both the service installation script and the service itself runs using the correct version of Java.

If the JAVA_HOME environment variable is not set, you have the following options:

  • Set the JAVA_HOME environment variable for the user running 1Integrate to point to the correct version of Java.

  • Follow the steps below to set the JAVA_HOME environment variable from the 1Integrate service start-up scripts.

To set the JAVA_HOME environment variable in the start-up scripts, carry out the following steps:

  1. Edit start-Interface-Service.cmd and install-Engine-Service.cmd.

  2. Locate the following lines:

    @REM Optionally uncomment and set this path to be the correct for your environment
REM SET "JAVA_HOME=C:\PROGRA~1\Java\[jdk_version]

  3. Uncomment the second line and remove "REM", so that it begins with "SET". Ensure that it is pointing to the location of Java home for the correct version of Java installed as part of the pre-requisites. The resulting line should appear as follows:

    SET "JAVA_HOME=C:\PROGRA~1\Java\[jdk_version]"

  4. Once configured, run the scripts to start the 1Integrate components.

Using Specific User Accounts

By default, the services run as the local system user. To use a specific user account you will need to run the start-Interface-Service.cmd and install-Engine-Service.cmd with the following parameters:

start-Interface-Service.cmd <domain>\<username> <password>
start-Engine-Service.cmd <domain>\<username> <password>

     Note: Using a named user account is required to use AzureAD authentication for SQL Server connections made by 1Integrate

Deploying the Service

Once you have checked your JAVA_HOME variable, you can deploy 1Integrate as a service by running the following scripts:

     Note: Both scripts must be run by an admin user account.

install-Interface-Service.cmd

The interface script will create a service with the name “1INTService" and the display name “1Integrate Interface [version]”.

install-Engine-Service.cmd

The engine script will automatically create N services with the name “1INTEngine[N]Service” and the display name “1Integrate Engine [version] #[N]“ based on how many engines have already been configured.

Configure additional engines (Service)

  1. Create a copy of the server-engine folder and rename it server-engine2 etc.

         Note: You must suffix server-engine with an integer.

  2. Inside the cloned directory, open the configuration\engine.conf.bat

  3. Update SET "ENGINE_NUMBER=1" to the corresponding number e.g SET "ENGINE_NUMBER=2"

  4. You are now ready to start the install-Engine-Service.cmd script, which will deploy all configured engines.

     Note: Along with the installation there are two uninstallation scripts. You will not need to define JAVA_HOME, as per the installation script. Uninstallation must be carried out prior to an upgrade, using the scripts packaged with the current installation, not the upgrade.

You can label engines you are deploying to group them, and control which Sessions run on different groups.

Windows

  1. Open the server-engine directory for the engine you will be applying labels to.

  2. Within the configuration directory, open the engine.conf.bat file.

  3. Locate and uncomment the following lines:

    SET "engine.labels="

  4. Add engine labels as a comma separated list:

    SET "engine.labels=label1,label2,label3"

  5. Repeat the steps for each engine being deployed.