3. Relay Manager

The Relay Manager is used to provide access to the Relay's endpoint data on an on-premise legacy system.

Praise Magidi avatar
Written by Praise Magidi
Updated over a week ago

The Relay Manager is required to be installed and running on the on-premise computer, either in memory or as a Service for an associated Synatic Relay to operate.

The Relay Manager can be downloaded from the Downloads button section in the Info tab of the Synatic Relay as shown in the image below. Once downloaded, follow the prompts to install.

Once installed, the Relay Manager can be started from the Windows Start menu. Search for the Synatic Relay Manager application that is installed on the server where the relay is. Run it as an administrator to open it.

Click on File and then New to create a new Relay as illustrated in the below image.

The page shown in the image below will appear.

Relay Stats The Relay Stats section which is outlined in red in the above image, displays the following operational statuses of the loaded Relay:

  • The Relay process is running or not. The relay process is usually triggered to run within a Synatic flow.

  • The Relay Service is installed or not. The service can be installed by clicking Install in the Relay tab.

  • The Relay Service is running or not. The service can be started by clicking Start in the Relay tab.

License Key – The License Key is the one provided on the initial Relay creation. The key is copied and pasted into the Relay Manager License Key field. Highlighted in yellow is how the key can be copied. It can be pasted in a safe note and then copied and pasted into the Relay Manager.

Relay Certificate The Relay certificate is created when the Synatic Relay is saved and should be downloaded via the Info Tab. The certificate is used to encrypt and secure the relay data between on-premise systems and Synatic.

Processes The Relay Manager can simultaneously process up to 50 endpoints.

Endpoints – The Endpoint block should contain the target URL and configuration for the Endpoint, which you can copy from the configuration file. This file can be downloaded from the Downloads group in the Info tab of the Synatic Relay and pasted into the Endpoints block.

<ACCOUNT>_<ENDPOINT>_config_ example.json.

"apiBase": "https://relay.synatic.com",
"relayKey": "specific key for the relay",
"processes": 2,
"logging": {
"filename": "relay.log",
"level": "info"
"Country Code Local File":{
"basePath": "C:\\RelayFiles"

Edit the config file according to the requirements that are needed such as the credentials, path or database.

File Tab

The file menu provides several options to manage the files related to the Relay as shown in the below page.

  • Open - Click to select and open a Relay.

  • New - Click to create a new Relay.

  • Save - Click to save the configuration of the open Relay.

  • Delete - Click to delete the currently open Relay.

  • Encrypt - Click to encrypt the current Relay configuration.

  • Exit - Click to close the Relay Manager.

Relay Tab

The image below shows the Relay menu which provides several options to test the Relay and manage the Relay Service related to the Relay.

Test – Click to execute a test on the settings of the configuration file. The test process will:

  • Test that a connection to the remote data source can be made.

  • Test that all the configuration settings are correct.

Test Run – Click the Test Run option to execute an end-to-end test from Synatic to the remote source data location. The Command Prompt window opens and displays the output of the running test script as illustrated in the image below.

Install/Uninstall Service – When Relay is tested successfully, install the Relay Manager Service. Click on the Relay menu and select the Install Service option as shown in the below image.

Select Local System as the service information as illustrated in the below image.

Start/Stop Service – When the Relay Manager Service is successfully installed. Click the Start Service option as per the below page.

Refresh – Click to reload the configuration of the current relay.

Wait a few minutes for the relay to refresh and show a successful last heartbeat heartbeat. Test the Relay from Synatic once it has been installed. The Heartbeat outlined in the image below shows that the Relay is connected and running successfully.

Useful Tutorials

Revisit the Getting Started page for a refresher.

Read the Relays overview.

Read more about Relays.

Learn more in the Relays Tutorial video.

Did this answer your question?