View source for Sync Dashboard

{{Academy|15|Synchronization & Sync Dashboard}}
{{Synchronization TOC}}
Data [[synchronization]] is one of the most important features of Resco's mobile applications. Sync Dashboard is a monitoring tool that allows administrators to see how your apps and users behave in terms of synchronization.

Sync Dashboard gives administrators full overview of synchronization details, and you can filter the information according to chosen preferences. Some of the questions that Sync Dashboard can answer:
* How many of your users have synchronization errors?
* How long does each synchronization take?
* How many of your users perform incremental syncs, how many full synchronizations?
* How many records are being synchronized at once?
* What's the average length of synchronization?
* What are the sync errors?

[[File:Sync dashboard filter and session view graphs.png|600px|alt=Sync dashboard filter and session view graphs]]

== Enable logging of synchronization data ==

This feature requires collecting information from mobile apps. It must be enabled in [[Woodford]]:
# Edit an app project.
# Select '''[[Auditing]]''' from the '''Project''' menu.
# Check '''Enabled''' to enable auditing in general.
# Check '''Log synchronization event'''.
# Save and publish your project.

Once your users update their application, auditing information about synchronization will be collected and available for further analysis in the dashboard.

== Accessing the dashboard ==

Sync Dashboard can be started from the management console of your CRM:

# Using a web browser, log in to your CRM.
#* In case of Salesforce, log in to salesforce.resco.net.
# Launch the dashboard:
#* For [[Resco Cloud]], select '''Sync Dashboard'''.
#* For [[Manager's experience|resco.Inspections]] or [[resco.FieldService]], select '''Audit Logs'''.
#* For Dynamics, select '''MobileCRM > Sync Dashboard'''.
#* For Salesforce, click '''Open Sync Dashboard'''.

If you cannot see any information on the dashboard, make sure that you have read permission for custom entities Mobile Audit, Mobile Device, Mobile Report, and Mobile Security Policy.

If you run into a <code>no data found</code> problem, try to ''turn it off and on again'':
# Disable auditing and publish the project.
# Enable auditing and publish the project.

== Using the dashboard ==

The dashboard screen is divided into three sections:

; Filter (top)
: You can restrict displayed data using the following criteria:
:* Set start and end date
:* Select a single user
:* Select synchronization type (full, incremental, or both)
:* Select device operating systems (iOS, Android, Windows)
:* Select sync results you want to see (successes, errors, warnings, tips, conflicts)

; Synchronization details (center)
: Displays the selected users and devices, including synchronization times for a given period 
:* Session view: general overview
:* Day view: similar to session view, but broken down per day
:* Device view: results are further broken down to each device

; List of all user logs with details (bottom)

: You can see a list of synchronizations here with detailed information about each run. The displayed synchronization data can be exported to a file in .CSV format.
: The '''Detail''' column shows the [[log files|synchronization log]]
: The '''Error''' column may contain information about issues encountered during synchronization
:* '''C''' – synchronization conflicts that require resolution
:* '''E''' – fatal errors that interrupt synchronization
:* '''I''' – information and tips for improving synchronization performance
:* '''W''' – warnings and non-fatal run-time errors

[[File:Sync dashboard devices and logs.png|600px|alt=Sync dashboard devices and logs]]

== Conflict resolution ==

This feature introduced in the Spring 2019 release allows you to view and [[conflict resolution|resolve synchronization conflicts]] from the Sync Dashboard.

=== Configure in Woodford ===

If you want that conflicts are resolved by administrators rather than mobile users, enable this feature using Woodford:

# Edit an app project.
# Select '''[[Configuration]]''' from the '''Project''' menu.
#* Set '''Log Conflict Details''' to '''True'''.
#* Set '''Diagnostic Sync Logs''' to '''True'''.
#* Set '''Remote Conflict Resolution''' to '''True'''.
#* Save your configuration changes.
# On your [[Data_model_in_mobile_apps#Managing_entities|entities]], set '''Conflict Strategy''' to '''Manual Action'''.
# [[Auditing|Mobile Audit]] of synchronization must be enabled.
# Save and publish your project.

=== Resolve conflicts on server ===

You can now display and resolve the conflicts using the dashboard.
# From the list of synchronization logs at the bottom of the dashboard, select one that includes conflicts.
# Click the '''C''' button in the '''Error''' column to display the list of conflicts.
# Select the records and then click '''Server version''' or '''Device version''' to choose a resolution.
# Click '''Save''' to save changes.

On the next synchronization, the resolution will be pushed to the mobile device.

== See also ==
* [https://blog.resco.net/2019/02/21/sync-dashboard/ Introducing Sync Dashboard] {{Badge|Blog}}
* [[SyncStats analyzer]] - a similar tool available in the mobile app that also offers some analytical insights

[[Category:Resco Cloud]]
[[Category:Synchronization]]