The article provides guidance on how to:
Accessing the Relay Page
To access the Relays page, follow the instructions below:
1. Log in to the org and click on Relays on the menu on the left as outlined in red in the image below.
2. The Relay page will open. Click on the Production Relay that is highlighted in the below image since that is the relay that is being used.
3. The selected relay page will appear.
Status of a Relay
The status of a relay refers to the last heartbeat of a relay which shows the connectivity of the relay.
There are three statuses which are the following:
Green Heartbeat:
The relay has connectivity to the server, and that it has been less than 10 minutes since the last heartbeat. If a Heartbeat is green but has some issues, it needs to be tested using the Test Relay button.
Yellow Heartbeat:
The service is falling out (an issue with the server or one of the systems that are being referenced in the relay), and that it has been 10-30 minutes since the last heartbeat. In cases of a Yellow Heartbeat, the relay can be restarted.
Red Heartbeat:
The relay has lost connectivity to the server due to a server issue or a system issue, and that needs to be investigated on the server itself, and that it has been more than 30 minutes since the last heartbeat. In cases of a Red Heartbeat, the server connectivity will need to be checked.
Testing a Relay
To test the heartbeat, click on the Test Relay button highlighted in the image below.
If there are any errors, an error message will be displayed showing the issue. An example of an error message is illustrated below.
If there are no errors, a result message will be displayed. An example of an error message is illustrated below.
Restarting a Relay
There are three ways to restart the relay.
1. Restart using the Restart Relay button
The service can be restarted to try and establish connectivity again by clicking on the Restart Relay button on the Synatic platform as shown in the image below.
2. Restart using the Task Manager on the server
The service can be restarted by going to the Task Manager on the server the relay is installed on.
1. Open the Task Manager.
2. Click on the Services tab and scroll down or search for Synatic with the relay name.
3. Right-click on the service.
4. Click on the Restart button.
3. Restart using the Synatic Relay Manager Application
The service can be restarted by going to the Synatic Relay Manager application on the server the relay is installed.
1. Search for the Synatic Relay Manager application that is installed on the server where the relay is.
2. Run it as an administrator to open it.
3. Click on the File tab and Click on the Open button.
4. Select the required relay and click on OK to open the relay’s configuration.
5. Click on the Relay tab and click on Stop Service. A pop-up box will appear to show that the service has been stopped.
6. Click on the Relay tab again and then click on Start Service. The pop-up box will appear stating that the relay has started again.
