Settings Hierarchy and Overrides: Riva On-Premise

Article ID: 1658
Last updated: 20 Jul, 2017

(Riva 2.4.43.37305 or higher.)

When an instance of Riva executes, settings are loaded from various locations. These settings are applied in order of least precedence to those of greatest precedence. When the same setting is configured in more than one location, the configuration in the location of greatest precedence overrides the configuration in the other locations.

Precedence

The following table lists the locations or types of Riva settings from the greatest precedence to the least precedence:

Precedence Type of Settings Comments
Greatest individual user settings These are the settings that are set as per Apply options to individual users in the sync policy.
individual user settings (external @settings reference) Settings that can be loaded from an external file reference. Configuring settings in one location that can be shared.
sync policy settings These settings reside in a ".policy" file in the Riva\Configuration\ folder.
connection settings A connection's settings reside in a custom.settings file in a folder named like this: Riva\Custom\[folder name based on the connection name]\en\settings

Example:

For a connection whose name is admin@demo.rivasync.com<>www.companyname.com,
the connection's settings reside in the file Riva\Custom\admin$demo$rivasync$com$www$companyname$com\en\settings\custom.settings

Note: It is possible to have setting for different languages based on the language settings of the synchronizing user. The default folder is "en".

Connection settings can also be organized in a hierarchy. The connection settings file that applies to the narrowest range of connections (for example, settings that apply to only one connection) overrides all the other connection settings files (which apply to multiple connections). There is no merging of the various connection setting files.

Example: To apply the same settings to three of four connections with a similar host, configure a custom.settings file and place it in a folder named Riva\Custom\www$companyname$com, and ensure that there is no custom.settings file in the individual folders for the three connections that need to be configured in the same way. The fourth connection has its own settings in its individual folder based on its connection name; these settings override the settings in the www$companyname$com folder.

For more information, see Connection settings.

connection settings (external @settings reference) Settings that can be loaded from an external file reference. Configuring settings in one location that can be shared.
versioned settings Example: ".config" files in the currently executing instance of Riva, such as

Riva\Application\2.4.43.37926

Note: If Riva has never been upgraded, the folder is Riva\Application\Base.

Tip: To confirm which version is configured to execute, see Determine which Riva On-Premise version is executing.

versioned settings (external @settings reference) Settings that can be loaded from an external file reference. Configuring settings in one location that can be shared.
versionless settings Example: ".config files" in the instance's "versionless" folder, Riva\Application\.

Note: Commonly used in a clustered multi-node deployment with Riva Shared Services.

Least versionless settings (external @settings reference) Settings that can be loaded from an external file reference. Configuring settings in one location that can be shared.

After all the settings have been loaded, the settings are merged at run-time. The resulting collection of merged settings is not saved anywhere, but it is logged.

If the same setting is configured in more than one place, the setting from the most specific precedence overrides the setting(s) in more general precedence order.

Examples:

  • An individual user setting overrides the sync policy setting when that user is synced.
  • If a setting has been specified in both the sync policy and a connection, the sync policy setting overrides the connection setting.

Connection Settings

  • New Custom.Settings files. When a connection's Custom.Settings file is created, it is placed in a folder that is exclusively dedicated to that connection.
  • Existing Custom.Settings files for connections. It is possible to share a Custom.Settings file with other connections by moving it to the appropriate folder. To help with that task, the Advanced Options page of the Connection Edit window has the following buttons:
    • View Search Paths: Displays the paths searched by Riva for Custom.Settings files from top (first) to bottom (last): from the folder dedicated to the connection all the way down to the most generic folder applicable to multiple connections. The folders do not necessarily exist, but if they have been created and are available, the system looks for resources in them.
    • Open in File Explorer: Opens the folder that contains the Custom.Settings file used by the connection.
  • Precedence: If more than one of the paths displayed in the View Search Paths window contains a Custom.Settings file, the settings in the topmost path override the settings in all the lower paths. At run time, the settings are not merged from the multiple paths - the first path with settings available is used.
  • Tip: From the View Search Paths window, it is possible to copy a path and use it to create the corresponding folders, and then move or copy a Custom.Settings file to the folder.

Note: It is possible to have setting for different languages based on the language settings of the synchronizing user. The default folder is "en".



Article ID: 1658
Last updated: 20 Jul, 2017
Revision: 13
Views: 5103
Also listed in
folder Riva On-Premise - CRM Sync -> Manage Riva On-Premise (Admin Guides) -> Scale Up with Multiple Riva Nodes

Prev     Next
Manage Sync Policies       Performance Counters in Riva On-Premise


Back to Top