Set Advanced or Custom Options for Connection or Sync Policy

Article ID: 312
Last updated: 05 Nov, 2018

Contents:

Is there a Difference Between Advanced Options and Custom Options?

In the Riva Manager application and Riva On-Premise documentation, both terms are used interchangeably.

These advanced options are made available for a number of reasons:

  • New features that do not yet have a user interface;
  • A way of changing default values used in advanced deployments or configurations;
  • When advanced configurations are specifically designed for a customer to meet a non-standard, customer-specific sync requirement. Typically, such options are provided through a billable professional service.

The Ways to Set an Option

There are multiple ways to set an option:

  • By interacting with the Riva Manager application user interface when selecting an option. (For example, by selecting a check box.)
    • Riva has many advanced features — only the most commonly used options are available in the user interface. These options are often initially available as advanced options, and then due to customer request, they are made available to the user interface.
  • Entering keys and values in the Riva Manager application: Many advanced options available to all users and many customer-specific options are applied by entering keys and values into fields, as described in this article.
    • This method provides support for
      • advanced options that are not used very often; and
      • non-standard, customer-specific advanced business requirements.
  • Editing a file in a text editor:
    • Some options are entered by creating or editing an App.Setting file.
    • There are many tiers of options that are applied. "Application Executable" > "Riva Instance" > "Per-Connection" > "Per-Policy" > "Per-User" > "Sync Now API". As a rule of thumb, these are applied from least specific (left) to most specific (right). For more information, see Settings hierarchy and overrides.

Applying Options by Entering Keys and Values into Fields

Apply advanced or custom options to a sync policy or connection object

Note: Because there is a distinct sync policy wizard and edit window for every supported email system, options specific to an email system are configured in the sync policy.

Key and value:

An advanced or custom option has two components:

  • a key: the name of the advanced or custom option; also known as the key name; and
  • a value: the part of the advanced or custom option that determines the option's behaviour; also known as the key value.

Example:

Sync.Crm.EmailFields.Contact = "Email,Email2,Email3" is the complete option.

Key (Key Name) Value (Key Value)
Sync.Crm.EmailFields.Contact Email,Email2,Email3

Notes:

  • The value is not case sensitive.
  • The equal sign (=) is not part of the option. It is used only in the documentation.
     

To configure advanced or custom options for a sync policy or connection object in Riva 2.4.43 or higher:

This procedure applies to Riva On-Premise 2.4.43 or higher.
For Riva 2.4.42 or earlier, see Configure options in Riva 2.4.42 or earlier.

  1. Best practice: If multiple option changes to the sync policy or connection are anticipated, stop the Riva synchronization service.

  2. Edit the relevant sync policy or connection.

  3. Select Advanced Options, and select Custom Options.

    Riva On-Premise. Edit CRM Synchronization Policy window.

  4. Best practice: In the Advanced Options window that appears, search for the key to confirm whether it already exists.

  5. If the key exists, it appears in bold within the list. To change the value, select the key from the list, and in the right pane, within the Key Value area, change the value.

    If the key name does not exist, select Add New. In the Option Properties panel, note that the Key Name has already been entered, and then enter the desired value in the Key Value.

    Select Update, and verify that the key and value appear as desired in the list.

    Riva On-Premise. Advanced Options window, which can be used to process custom options. 1. At the top, search for a key and/or 2. add a key. 3 and 4. Provide for the advanced or custom option a Key Name and a Key Value. 5. Near the bottom, select Update. 6. To the left, in the large list box, verify that the new key is listed.

  6. In order to add multiple keys and their values: For each key and value, repeat steps 4 and 5.

  7. When done editing, select OK.

  8. Save the sync policy or connection.

  9. If the Riva synchronization service was stopped at step 1, start it.

Apply advanced or custom options to individual users in the Riva sync policy

To set advanced or custom options for specific users in Riva 2.4.43 or higher:

  1. Best practice: If multiple option changes are anticipated, stop the Riva synchronization service.

  2. In the Riva sync policy, select the Re-Initialize or Sync Start Time tab.

    Note: In sync policies created in Riva 2.4.46 or higher, the Re-Initialize page replaces the Sync Start Time page.

  3. Select a user, and select the third icon from the left (User Advanced Options).

    Riva On-Premise. In the Edit CRM Synchronization Policy window, on the Sync Start Time page, select a user, and select the third icon from the left.

  4. Best practice: In the Entity Advanced Options window that appears, search for the key to confirm whether it already exists.

  5. If the key exists, the key will appear in bold within the list. To change the value, select the key from the list, and in the right pane, within the Key Value area, change the value.

    If the key name does not exist, select Add New. In the Option Properties panel, note that the Key Name has already been entered, and then enter the desired value in the Key Value.

    Select Update, and verify that the key and value appear as desired in the list.

    Riva On-Premise. The Entity Advanced Options window.

  6. Select OK to close the Entity Advanced Options window.

  7. To save the changes,

    • Right-click the selected user, and then select Save Changes; or
    • Save the sync policy.
       
  8. If the Riva synchronization service was stopped at step 1, start it.

How the Changes to the Advanced or Custom Options Are Applied

The changes made to the advanced or custom options take effect as follows:

  • Connection and Sync Policy changes: If the synchronization service is already running, the service detects changes to the synchronization policy and will automatically restart the synchronization with the new configuration.
  • Per-User change: During the user's next synchronization cycle, the new options are automatically used. If changed keys were applied only to users, there is no need to modify the synchronization policy.

Which Data Is Affected

Applying an advanced or custom option to a sync policy affects all the data that Riva syncs afterwards.

To apply the advanced or custom option to previously synced data, the users need be re-initialized. For instructions on selecting the correct re-initialization option, see Manage syncing users and re-init options for sync policies.

Applies to

No legacy GroupWise support for advanced or custom options:

  • Legacy GroupWise sync policies do not support advanced or custom options. We recommend upgrading to the newer GroupWise SDK connection.



Article ID: 312
Last updated: 05 Nov, 2018
Revision: 15
Views: 14880
Also read
item Private Appointments Handling
item CRM Sync Policy: Scheduling - Control Drop Folder Check Frequency
item Disable Alarm and Reminder Synchronization
item Advanced Settings for Apple, Android, BlackBerry, and Other ActiveSync Mobile Devices
item Enable CRM to Mailbox Unidirectional Read-Only Sync
item Create & Configure a Sync Policy for Exchange or IBM Notes
item Remove "Bad" Categories from Previously Synced Items or Users' Master Category List
item Keep Trying to Sync Emails That Do Not Match CRM Contacts or Leads
item Salesforce: Ability to Sync Attachments for Emails
item Oracle On Demand: Enable Book and Subbook Filtering
item Collector Accounts: Allow Creating Contacts Without Allowing Creating Accounts

Prev     Next
Poll for Account Name Changes More Frequently       Restore Riva Lost & Found Items


Back to Top