This article explains how to install OneConnect relays. See What is a Relay? for more information on relays.
-
Log into OneConnect.
-
Click on the Gear icon. This will expand the available settings options.
-
Select Relays. A page with all the available relays is made available.
-
Click on the toggle to include the integration programs that will be used.
Note
If the integration includes OnePlan, there is usually no need to include the OnePlan side. However, please feel free to contact your support team to find out if the OnePlan side to the relay is needed.
-
Click Download.
The Relay Agent installer that is generated may need to be “unblocked” after downloading to avoid security warnings.
To “unblock” a file, right-click it in Windows Explorer, choose Properties from the context menu, check the Unblock checkbox in the lower right-hand corner of the resulting dialog, and click OK or Apply.
-
Extract contents of OneConnect.Connectors.Relay.Setup_{version & date}.zip.
-
Open folder of extracted zip.
-
Run OneConnect.Connectors.Relay.Setup.msi.
-
Click Next.
-
(Optional) Change installation folder.
-
Click Next.
-
Click Next.
Note
During the installation process a prompt will display, shown in the screenshot.
Note
Sometimes the ‘Relay Configuration’ modal will be displayed behind but can be accessed in the Task bar.
-
Fill in the ‘Relay Configuration’ prompt’s
-
Service Namespace: *-oneconnect-relay (*provided by OnePlan)
-
Shared Access Key:* (*provided by OnePlan)
-
-
Click Continue.
-
Click Close.
-
You can confirm the Relay Agent is running by opening Services.msc as shown in the screenshot.