Deployment

Once you have installed 1Integrate, it is now ready to be deployed. The method of deployment will differ depending on your Operating system or deployment type.

Standard Deployment

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.

JAVA_HOME

Once you are sure you have the correct version of Java installed, you will need to ensure that the JAVA_HOME environment variable points to this for the user running 1Integrate.

     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.

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 for Windows and Linux to set JAVA_HOME from the 1Integrate start-up script.

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

ClosedWindows

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

  2. Locate the following lines:

    3. @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 by removing "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.

ClosedLinux

  1. Edit start-Interface.sh and start-Engine.sh.

  2. Uncomment the line just below “#Optionally uncomment and set this path to be the correct for your environment”:

    export JAVA_HOME="/opt/jdk"

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

Starting 1Integrate

You can now run the start-up scripts:

  • start-Engine

  • start-Interface

Once run, 1Integrate will be ready to use. For information on ensuring your installation and deployment has been successful, please refer to Testing the 1Integrate Installation.

Configure additional Engines

1Integrate can be deployed with multiple engines each of which can run either on the same server as the interface or on separate machines (as long as they are on the same network as the interface).

Engines can be run in parallel, deployed using different port numbers. This requires a license from 1Spatial that enables the required number of parallel engines.

     Note: On a machine running Windows, this may present a path name length error. If this occurs, copy the server-engine folder to a higher level directory, rename it, and paste it back into the 1Integrate_[version] folder.

     Note: For more advanced environments, contact either your distributor or 1Spatial prior to continuing to discuss an appropriate deployment plan.

You will need to copy and edit a different file, depending on if you are using Windows or Linux.

ClosedWindows

  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. Create a copy of the start-Engine.cmd file and rename it.

         Note: When deploying multiple engines, ensure you run each start-Engine.cmd file you have created.

  5. Edit this file to refer to "ENGINE_NUMBER=2" instead of "ENGINE_NUMBER=1" (or "ENGINE_NUMBER=3" for the third engine etc.)

ClosedLinux

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

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

  2. Create a copy of the start-Engine.sh file and rename it start-Engine2.sh.

    Edit this file to refer to server-engine2 instead of server-engine (or server-engine3 for the third engine etc.) and change the port offset at the end of the startup line from 100 to 200 (or 300 for the third engine etc.).

     Example: The line

./bin/standalone.sh -P=SETTINGS/settings.properties -Djboss.server.base.dir=server-engine =Djboss.socket.binding.port-offset=100

would be changed to

./bin/standalone.sh -P=SETTINGS/settings.properties -Djboss.server.base.dir=server-engine2 =Djboss.socket.binding.port-offset=200.

Engine Labels

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.

Linux

  1. Open the start-Engine.sh script for the engine you are applying labels to.

  2. Locate and uncomment the following lines:

    export engine.labels=""

  3. Add engine labels as a comma separated list:

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

  4. Repeat the steps for each engine being deployed.