Riva CRM Integration - Documentation and Knowledge Base

How to Install and manage the 64-bit Riva Sync Service

Article ID: 1257
Last updated: 25 Nov, 2022

This article will discuss when and how to install and manage the 64-bit Riva Sync Agent Service.

What is the 64-bit Riva Sync Agent Service

Riva now offers a 64-bit sync service. By switching to 64-bit services, Riva can take advantage of the additional system resources that 64-bit Windows servers can make available, resulting in a much more stable and efficient Riva server. Riva will be able to handle greater loads resulting in more users syncing concurrently and faster sync cycle completion times.

When should customers use the 64-bit Riva Sync Service

The 64-bit version of the Riva sync service is recommended for Riva On-Premise deployments of more than a total of 100 users being synced.

System requirements

The recommended system requirements:

  • Deploy Riva On-Premise to a supported Windows server platform for more than 100 syncing users.
  • Riva 2.4.40 or higher.
  • For Riva 2021.1 or higher, .NET 4.7.2 framework is required.
  • For Riva 2.4.55 or higher, .NET 4.5.2 framework is required.
  • For Riva 2.4.40 through Riva 2.4.54, .NET 4.5 framework is required.

Installing and managing the service

How to install the service

Typically, Riva On-Premise installations will install the 32-bit sync service called Omni Riva (CRM Agent for Exchange).  This service needs to be removed

It is critical to ensure that the Riva CRM synchronization service on the source Windows system be removed. This is necessary to prevent creating duplicate records in the CRM, which would occur if two instances of the Riva CRM synchronization service configured against the same target systems and users were running concurrently.

  1. On the source Riva server, start the Riva Service Monitor application, and stop the service.

  2. Open Windows Services and confirm that the Omni Riva (CRM Agent for Exchange) or the Omni Riva (CRM Agent) status is blank. If the status is displaying Stopping, see Riva service is "Stopping..." for steps to force the service to stop.

  3. In Windows Services, open the properties of the Riva CRM Agent service and copy the path to the service to the Windows clipboard.

  4. Open a CMD prompt with elevated privileges (Run as administrator).

  5. Enter CD \ and press ENTER. Type a " (double quotation mark), then click in the CMD prompt window, right-click, and select Paste. After \Omni.Riva.CrmAgentEx.exe, add a " (double quotation mark), add a space, type --uninstall and press ENTER.



    That cmdlet will uninstall the service and remove it from the list of installed services. When Done! appears, press ENTER.
  6. Type a " (double quotation mark), then click in the CMD prompt window, right-click, and select Paste. Modify .CrmAgentEx.exe to CrmAgentEx64.exe, add a " (double quotation mark), add a space, type --install and press ENTER.



    That cmdlet will install the 64-bit sync service. When Done! appears, press ENTER.

  7. Refresh Windows Services and confirm that the Omni Riva (CRM Agent for Exchange) has been removed from the list of installed services and the Omni Riva (Sync Service) service has been added.


     

  8. Select the Recovery tab and set the first, second and subsequent failure options to Restart the Service.

  9. Select Apply and OK to close the property service window.

  10. Close Windows Services (optional).

How to reinstall the service to upgrade it to a newer release

If Riva 2.4.40 or higher is installed and the 64-bit sync service is installed, Riva will detect that service and upgrade it when the Riva On-Premise server is upgraded.  After Riva has been upgraded, it is a recommended best practice to confirm that the path to the service executable matches the version that Riva was just upgraded to.

How to stop, start and restart the service

Once installed, the service can be controlled in one of three ways:

  • In the CRM Service Monitor application, use the STOP, START, and RESTART buttons.
  • In the Windows Services manager, use the service control buttons, and right-click the service and select the action.
  • In the CMD prompt (run as Administrator), use Net Stop and Net Start commands:

    Net Stop Riva_Service_CrmAgentEx
    Net Start Riva_Service_CrmAgentEx

How to roll-back the service

Refer to How to Roll-back a Riva On-Premise Server.

How to uninstall the service

Refer to steps 1 to 5 above.

Article ID: 1257
Last updated: 25 Nov, 2022
Revision: 17
Views: 53