Riva Sync Service - Install and Configuration Guide

Christian Delorey
Christian Delorey
  • Updated

This article describes how to install, reinstall, and configure the Riva Sync Service on Windows. 

Overview

The Riva Sync Service is the Windows service that executes Riva sync policies and runs background synchronization tasks for your Riva On-Premise deployment.

You can install or reinstall the service either by saving a sync policy or manually via the Windows command line. After installation, you must verify key service properties (startup behavior, recovery options, logon identity) to ensure reliable operation.

Installing or Reinstalling the Riva Sync Service

Option A - Install by Saving a Sync Policy

  1. Open the Riva Manager.
  2. Under the Policies sections, select a policy and edit it. 
  3. Click Save. 
  4. When prompted that the Riva Sync Service is not installed, click Yes to install and start the service. 
    Service-Install-Prompt (6).png
  5. If the policy is disabled, the service will start, but not perform any sync operations until the policy is enabled. 

Option B - Manual Installation via Command Line

  1. On the Windows host, open Command Prompt as Administrator. 
  2. Navigate to the Riva Runtime folder. Typical paths are: 
    Riva\Application\RunTime
    If this folder doesn't exist, look for a versioned folder: Riva\Application\2025.4.10.XXXX
    If no versioned folder exists, use: Riva\Application\Base
  3. Copy the full folder path and paste it into Command Prompt.
  4. Append the install command: Omni.Riva.CrmAgentEx.exe --install
  5. Press Enter to install the service. 

    Install-the-CRM-Agent-Service-(command-line)- (4).png

Configure the Riva Sync Service

After installing the service, you must validate or adjust the following properties to ensure stability and availability.

Startup Type

  • Set the Startup Type to Automatic (Delayed Start). 
  • This ensures the service starts after a system restart and waits for other essentials services to initialize. 
  • Delayed start helps reduce race conditions on busy servers. 

    sync-service-properties-general(1) (4).png

Recover Options

Set meaningful recovery behavior to improve resilience:

  • In the service Properties -> Recovery tab: 
    • First Failure: Restart the Service
    • Second Failure: Restart the Service
    • Subsequent Failures: Restart the Service

      sync-service-properties-recovery (6).png

This configuration helps the service recover automatically after transient errors or unexpected stops.

Log On Identity

Riva’s Windows service can run as either the Local System account or a specified domain account.

  1. Open Services.

  2. Find Omni Riva (Sync Service).

  3. Open Properties → Log On.

  4. Select This account.

  5. Browse and choose the appropriate domain account.

  6. Enter and confirm the password.

  7. Verify that the account appears under the Log On As column.

Daily or Scheduled Restart (Optional)

In some environments, you may enforce a daily restart of the Riva Sync Service to release memory and improve long-term stability. 

This setting requires adjusting an AppSettings key in the Riva Configuration files. Review the Knowledge Base Article on "Force Restart of the Riva Sync Service" or Contact the Riva Technical Support team for assistance.