Uninstall and Update a Relay

  • Updated

Only a single relay can be installed in a server at a single time. Because of this, uninstalling a relay will be necessary to update to a newer version of the relay.

  1. Take a Backup of the Relay Configuration Files. Take a backup of the OneConnect.Connectors.Relay.Agent.exe.config file from the current relay folder. The current relay folder will be where the relay was installed from the initial installation steps.

  2. Uninstall the Existing Relay. Using the computer's Add/Remove Programs tool, locate OneConnect Relay Agent and uninstall the program.

  3. Reinstall the Relay. From here, follow the Relay Installation instructions.

  4. Update Relay Configuration Files. Once the new relay has been installed, navigate to the relay folder, and compare the OneConnect.Connectors.Relay.Agent.exe.config files from the old relay configuration files. For pathing values or service account information, overwrite these values from the old configuration to the new one.

    This is to ensure that any environment-specific values are not overwritten with the default configuration values from the newly installed relay. The values in question will look like pathing values, especially anything that is referring to <appSettings> nodes. An example is provided below:

    <add key="EnvironmentSpecificSetting_PathToFile" value="C:\test\folder\file.csv"/>
    
    <add key="EnvironmentSpecificSetting_ShouldRunProcess" value="true"/>
    
    <add key="EnvironmentSpecificSetting_BaseUrl" value="https://somedomain.com/"/>

    Note

    Knowing exactly what values should be set can be confusing if you do not know what you are looking for, we suggest reaching out to Support to go over the values in question to verify what should be changed or not.

  5. Save any changes made, and start the new relay.

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request