Riva CRM Integration - Documentation and Knowledge Base

Export and Import a Riva Sync Policy Migration Package

Article ID: 1698
Last updated: 11 May, 2018

A migration package is a password-protected, zipped .riva file that contains the files required to move a policy or group of policies to a new Riva instance or server.

This article applies to Riva 2.4.47 or higher.

For Riva versions 2.4.41 through 2.4.46, see Export and import Riva sync policies and associated folders and files.

See also Create a package for technical support.


To generate a migration package:

  1. In the Riva Manager application, on the menu bar, select Policies.

  2. In the right pane, right-click a policy that is to be migrated, and select Export for Migration.

    Result: The Generate Migration Package window appears.

Generate Migration Package


  • In the Generate Migration Package window, multiple policies can be selected to produce a single multi-policy package.
  • The policy or policies are automatically disabled before inclusion in the package, so that they cannot start syncing as soon as they are extracted to the new instance or server. That precaution provides the opportunity to change the configuration before the policies are enabled to sync.
  • The zipped .riva package does not include security certificates. It includes only pointers to the certificates. Take security precautions when migrating a copy of a certificate to another instance of Riva.
  • In this first implementation, the migration package does not include connection groups or Google dynamic connections. Add the related files to the Additional Files list box.

To use the Generate Migration Package window to build and export the package:

  1. In the top list box, select the policy or policies that need to be migrated.

  2. Under the list box and under Select Configuration File, read the instructions. If applicable, in the second list box, select the configuration file.

  3. If applicable, to the right of the third list box (named Additional Files), select Add. In the Open window that appears, navigate to and select the additional files to add to the package.

  4. Select Open.

    Result: The .zip file or files that you selected appear in the Additional Files list box.

  5. Under the Additional Files list box, to the right of the automatically generated password, select Copy Password.

  6. Paste the password in a secure location.

    Warning: After the Generate Migration Package window is closed, the Riva Manager application has no access to the password. If the password is lost, the package cannot be opened and a new package must be generated.

  7. Select Export.

  8. In the Save As window that appears, navigate to the location where you want to save the migration package, optionally change the File name, and select Save.

    Expected Result: The migration package is generated and saved as a zipped .riva file with the specified name at the specified location.

  9. If an Export Fail window appears, follow the instructions in it.

  10. If the export is successful, take security precautions to protect the .riva migration package on its way to another Riva instance or server.


To import a .riva sync policy migration package:

  1. In the Riva Manager application, on the menu bar, select Policies.

  2. In the right pane, along the top, select Import.

    Result: The Import Package window appears.

Import Package

The Import Package window is where you import into a Riva instance or server the .riva migration package that was exported from another instance or server that uses Riva 2.4.47 or higher. The package import utility provides a warning if imported files would overwrite existing files, and the import does not proceed.

Caution: If you have used the Extract utility in any of the versions ranging from 2.4.41 through 2.4.46, you can extract the resulting .zip file manually, but, without a warning, it may overwrite existing files that have the same name and are located in the same relative path from the Riva folder.

Tip: Change the zip file extension to riva, and then use the following procedure.

To use the Import Package window in Riva 2.4.47 or higher:

  1. To the right of the Select Package field, select .

  2. In the Open window that appears, navigate to the .riva package that you want to import, and select Open.

  3. In the Password field, enter the password that was generated in the Generate Migration Package window.

  4. Select Import.

  5. If the Conflicts Warning message box appears, select OK to view the report. Cancel the import, and resolve the conflicts.

  6. If the Import Succeeded message box appears, select OK. Wait for the Riva Manager application to restart so as to refresh the connections and policies.

    Note: Even though the Riva Manager application restarts, the imported Riva sync policy or policies are disabled, so that changes can be made to the Riva configuration before the sync begins.

Article ID: 1698
Last updated: 11 May, 2018
Revision: 5
Views: 4499