Handling Synchronization Issues¶
For users of the Email Sidebar on:
8 min read
When using RGES Sync functions, sometimes you may encounter particular mailbox → Salesforce data synchronization issues that can block syncing of certain items or even disable the synchronization completely.
This article provides a detailed overview of how to identify and investigate synchronization issues and ways to address them.
Identify synchronization issues¶
There are several ways how you can find out that a sync issue has occurred and some data failed to be synchronized between your mailbox and Salesforce.
1. As a first sign of a synchronization issue, RG Email Sidebar will mark an affected object in your mailbox with a custom category, label, or color to let you know about it:
- In MS Outlook, the item for which a sync issue occurred is assigned two custom categories: a red “Sync Error” category and a white category providing extra details
- In Gmail mail client, the item for which a sync issue occurred is assigned a custom label “Sync Error” or a red marker for calendar items
2. Another way to identify sync issues is to check the logged data on the Sync Settings page. RG Email Sidebar logs all occurred synchronization issues and errors in Sync Setting, providing an ability to monitor, investigate, and resolve them efficiently.
3. In addition, all issues are also registered in RGES Admin panel for monitoring and resolution by the local Admin.
Important
Depending on your license, the appearance of your Sync Settings page may be different. Below you can find information on how to handle synchronization issues on the New and Legacy Sync Settings pages. Refer to the chapter that corresponds to the appearance of your Sync Setting page:
Handling sync issues on the new Sync Settings page¶
Investigate synchronization issues¶
When RGES Sync Engine encounters conflicts between synchronized data sources or is unable to run synchronization to less obvious reasons, all synchronization issues details are reflected in Sync Settings on the General and Issues tabs.
To conduct an issue investigation, you need to check the logged information, which can include the issue cause description, advice for resolving it, or a sync error code.
To access Sync Settings, open RG Email Sidebar in your mailbox, click Menu, and go to Sync Settings.
General tab¶
On the General tab in Sync Settings, you can check the synchronization status, the last sync session details, as well as sync error messages if any occurred.
- Click Last session details to view the logged information about the last synchronization. Also, use the Refresh button to update the details if another sync session has run recently.
- If there is a sync error message, click Show details to see the detailed error description and recommendations on how to address it, when available
Issues tab¶
On the Issues tab, you can find the issue’s log, which usually includes a sync error code or notification returned by RG Email Sidebar and indicates the source of the error, date and time when the error occurred
Tip
You can instantly view the Salesforce or MS Exchange / Office 365 / Google record that caused the issue by clicking the mail client or Salesforce icon under Connectivity
Account credentials changed¶
When your Salesforce or MS Exchange / Office 365 / Google credentials are changed, RG Email Sidebar can no longer access your data, and the corresponding Sync error message appears on the General tab in Sync Settings.
Also, refer to the Credentials renewing section below for more information.
In addition, for cases when RG Email Sidebar is unable to access your Salesforce or mailbox data or when data syncing fails 10 times consecutively, you will receive a notification email informing you about the need for action to resolve the issue and resume data syncing.
Resolve synchronization issues¶
Once you investigate the sync issue, you need to follow the handling recommendations described in the issue details. If there are no recommendations, proceed with the following steps to address it:
-
If the issue occurred because required data was missing or invalid data was entered into some field, enter or correct the corresponding data
-
If the issue occurred due to authorization problems, refer to the Credentials renewing section below for a solution
-
If the issue has an error code, consult the table of Sync error codes for a solution
-
For the cases when you or your admin cannot resolve an issue locally, it is recommended to contact our Support and CSM team:
On the Issues tab, click ⋮ (More) icon under Actions, click Chat with support, and send a report to our team. Make sure to include details and screenshots, when applicable.
Important
Note that when you are using RG Email Sidebar there should be no other software running that performs data transfer between MS Exchange and Salesforce API (e.g. Salesforce Lightning sync, Salesforce Inbox, Salesforce for Outlook, etc.) Running different MS Exchange – Salesforce sync applications simultaneously will cause sync conflicts and items duplication. If you encounter this kind of unexpected behavior, please check that with your Salesforce admin or, if you are a Salesforce admin, check for such software in the following places:
- Salesforce Setup > Apps > App Manager
- Connected Apps
- Salesforce Login History. After you find apps which cause sync conflicts, please refer to this Salesforce help article to learn how to disable them. Please also note that apps which use Salesforce API but do not exchange data between Salesforce and MS Exchange will not cause sync conflicts
Handling sync issues on the legacy Sync Settings page¶
- Issues. Synchronization issues are logged in the tab when RGES Sync Engine encounters conflicts between synchronized data sources or due to less obvious reasons. Every issue’s log usually includes a sync error code or notification returned by RG Email Sidebar and indicates the source of the error. Also see this article for a table of possible Sync errors
- Account credentials changed. Occurs if your Salesforce or MS Exchange / Office 365 / Gmail credentials were changed and RG Email Sidebar can no longer access your data. See the section below Credentials renewing for more information
Additional information about each Sync issue can be found in the Dashboard. If your local Admin cannot resolve the issue locally, you can get our Support Team’s assistance by clicking the Help me resolve this issue button under an issue and submitting a detailed description including error codes and screenshots by email.
In addition, for cases when RG Email Sidebar is unable to access your Salesforce or mailbox data or when data syncing fails for 10 times consecutively, you will receive a notification email informing about the need for action to resolve the issue and resume data syncing.
In case a persistent Sync issue occurs, for example due to Sync misconfiguration or user account switching to another tenant, see this article to learn how to revoke Sync data authorization token. After that, re-activate Sync for the mailbox.
Investigate synchronization issues¶
A synchronization issue occurs when RG Email Sidebar is unable to synchronize data between Salesforce and Microsoft Exchange / Office 365 / Gmail due to some reason. In many cases, these issues are caused by required data unavailability on email server side, e.g. missing Contact key fields values, like Last name, or by specific Salesforce rules that may prevent users from editing or deleting records of certain types.
When a Sync issue occurs, RG Email Sidebar notifies the concerned users in the following ways:
- In MS Outlook, the item for which a Sync issue occurred is assigned two custom categories: a red “Sync Error” category and a white category providing extra details
In Gmail mail client, the item for which a Sync issue occurred is assigned a red marker (Events) or a custom label “Salesforce Emails/Sync Error”
- Information about logged sync issues is displayed on the Issues tab of RG Email Sidebar’s Dashboard. To view issues for a certain processed item type: under Issues, select issue type. Note that you can instantly view the Salesforce (or MS Exchange) item that caused the issue by clicking the Salesforce or Exchange icon on the right
- All issues are also registered in RGES Admin panel for monitoring and resolution by the local Admin
Resolve synchronization issues¶
-
If the issue occurred because a required (key) field was left empty, fill in the missing key fields
-
Consult the table of Sync error codes for a solution
-
For the cases when an issue cannot be resolved locally, it is recommended to contact our Support and CSM team: you can click the Help me resolve this issue button and send a report; make sure to include details and screenshots, when applicable
Important
Note that when you are using RG Email Sidebar there should be no other software running that performs data transfer between MS Exchange and Salesforce API (e.g. Salesforce Lightning sync, Salesforce Inbox, Salesforce for Outlook, etc.) Running different MS Exchange – Salesforce sync applications simultaneously will cause sync conflicts and items duplication. If you encounter this kind of unexpected behavior, please check that with your Salesforce admin or, if you are a Salesforce admin, check for such software in the following places:
1. Salesforce Setup > Apps > App Manager
2. Connected Apps
3. Salesforce Login History. After you find apps which cause sync conflicts, please refer to this Salesforce help article to learn how to disable them. Please also note that apps which use Salesforce API but do not exchange data between Salesforce and MS Exchange will not cause sync conflicts
Renewing Salesforce or Mail Data Access Credentials¶
If Exchange / Office 365 / Google or Salesforce access credentials expire or get changed, RG Email Sidebar can no longer synchronize users’ data. After that happens, affected end users or their Admin receive a notification email with instructions how to re-activate the Sync Engine via the Sidebar; a corresponding notification will also appear in users’ RGES Dashboard.
To renew MS Exchange / Office 365 or Salesforce access for RGES Sync Engine, follow the steps provided in this article.
In case a persistent Sync issue occurs, for example due to Sync misconfiguration or user account switching to another tenant, see this article to learn how to revoke Sync data authorization token. After that, re-activate Sync for the mailbox.
Also see additional details on Salesforce access renewal in this article.