The Relay Manager is used to provide access to the Relay's endpoint data on an on-premise legacy system. It's 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 group in the Info tab of the Synatic Relay.

  • Click on the downloaded SynaticRelayManagerSetup.msi and follow the prompts to install.

  • To set up and use the Relay Manager, you require Administrator permissions and you must run the Relay Manager as an Administrator.


Relay Stats

The Relay Stats group 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. You can install the service under the Relay tab.

  • The Relay Service is running or not. You can start the service under the Relay tab.


License Key

The License Key is initially generated when you first create and save a new Synatic Relay. You will see the Key in the resultant Generated Relay Key dialog.

  • You should copy and save the Key for safety reasons.

  • Paste the License Key into this field in 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 <ACCOUNT>_<ENDPOINT>_config_ example.json. This file can be downloaded from the Downloads group in the Info tab of the Synatic Relay and pasted into the Endpoints block.

{
"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 to reflect only the endpoints as shown below for this relay.

{
"Country Code Local File": {
"basePath": "C:\\RelayFiles"
}
}


File Menu

The file menu provides several options to manage the files related to the Relay.

  • 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 Menu

The Relay menu provides several options to test the Relay and manage the Relay Service related to the Relay.


Test

  • Click the Test option to execute a test on the settings of the configuration file.

  • The test process will:

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

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

This test can be done in one of two ways while the DOS script is running:

1. Run a simulated test in a Synatic Flow.

  • Click on the blue Test button.

  • This test may take some time.

  • If successful, the content of the data file will be displayed.

  • The Command Prompt window will display the results on the Relay Test script.

2. Run the Test Relay in the Synatic Relay Info Tab.

  • Go to the Synatic Relay you created and open the Info Tab.

  • Click on the Test text button to initiate the test.

  • This test may take some time.

  • If successful, you'll see the result in the Info tab shown above and also in the Command Prompt window shown below.


Install/Uninstall Service

When you've tested the relay successfully, you can now install the Relay Manager Service. When the Service is running, it implies that you do not need the Relay Manager to be running when the data is requested from the Synatic Flow.

  • Click on the Relay menu.

  • Select the Install Service option.


Start/Stop Service

  • When the Relay Manager Service is successfully installed.

  • Click the Start Service option.


Refresh

  • Click the Refresh option to reload the configuration of the current relay.


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?