Create a Local Core under a Relay

This section gives a tutorial on how to create and configure a Local Core object to operate beneath a Relay object. Data from the Local Core is then transferred to the Master Core object.

Currently only the default authentication mode (TLS_SRP) is supported for Intercomponent Communication via Relays.

In this example configuration, we will have 3 different host machines that will run the following components:

  • Master Core

  • Relay service

  • Local Core

In the configuration steps, it is important to use the hostnames in the initial naming of objects in DataStudio, so for this example, we will use the hostnames shown for each component layer in capital letters in the below diagram.

local core relay mastercore
In the following example, it is important that the initial steps (where the objects are created in the I/O Model) are completed before the installation of the Relay and Local Core services on the other host machines. The configuration will not work if done in a different order.
  1. On the MASTERCOREHOST machine, first do a full installation of all components using the Window Installer. If using an existing Master Core installation, go to the next step.

  2. Open DataStudio and select the Core Object (with a new installation, it should be named with the MASTERCOREHOST hostname by default). Right-click and select Admin  New  Services  Relay Server from the context menu.

  3. In the Create Object Wizard, set the Object Name property to the hostname of the machine where the relay service is running (use RELAYHOST for this example). In the Communication property section, enter the same hostname (e.g. RELAYHOST) for the Hostname or IP Address and leave the port number as the default 6511. Click Create to create the Relay object in the I/O Model.

    On the initial setup, the name of the Relay Server object has to be the hostname of the machine on which the Relay service is running.
  4. Select the newly created Relay object and then right-click and select Admin  New  Services  Core from the context menu. This will be the designated object for the Local Core.

  5. In the Create Object Wizard, set the name property to the hostname of the machine where the Local Core service is running (use LOCALCOREHOST for this example). Enter the same hostname (e.g. LOCALCOREHOST) for the Hostname or IP Address and leave the port number as the default 6512. Click Create to create the Core object in the I/O Model.

    On the initial setup, the name of the Core object has to be the hostname of the machine on which the Local Core service is running.
  6. Once the objects in the I/O Model are created, we can now install services on the other host machines. This can be done using the Window Installer for the Local Core service and the Node Installer for the Relay service. These services can also be installed from the Command Line and examples will be given for both.

  7. Firstly, for the Relay service, go to the RELAYHOST machine and open the Node Installer. You can either create a default instance (if no other components have been installed on the machine) or create a new instance of the Relay service. In the Advanced Relay options, select Active Component and enter the MASTERCOREHOST hostname in the Core Host field. The Core Port should be the listener port of the MASTERCOREHOST Core service used during setup (default is 6512). Click OK to save the Advanced configuration then OK again to install the service.

    If using command line installation, go to the "bin" folder in the root directory and enter the following command:

    inmation.exe -i Relay --relayport 6511 --connect 1 --corehost MASTERCOREHOST --coreport 6512

    This will install an Active Relay service. If you want to create a new instance of the Relay service on the machine, use the --instance argument described here.

  8. Now the Local Core service can be installed. Go to the LOCALCOREHOST machine and run the Window Installer. On the first page of the installer, you can leave all the feature checkboxes ticked and then check that you agree to the license terms and conditions, and click Install.

  9. Click through the default options until you reach the Core Options: Role page. Here, make sure you click on the Local Core option and then in the Master Core or Relay Host field, enter the RELAYHOST hostname, and enter "6511" in the Port field (the default Relay service listener port).

  10. Click through the rest of the Window Installer options until the end, then click on Install to install the Local Core service.

    If using command line installation, go to the "bin" folder in the root directory and enter the following command:

    inmation.exe --execute Core --corerole local --corehost RELAYHOST --coreport 6511
  11. If all steps have been successfully completed, the I/O Model in the MASTERCOREHOST DataStudio instance should show 2 green lights by the side of the Local Core object indicating that the connection was successful.

After a service has been installed and the initial connection to this service has been established successfully, the name of the object representing the service in the I/O Model can be changed.