Sync Health Board

Prerequisites

Basics

The Sync Health Board displays real-time metrics about Sync Engine performance.

If your org has enabled auto sync to automatically upload data from FieldFX Mobile to FieldFX Back Office, use the Sync Event Viewer instead. The auto sync upload feature is currently still in development.

Use the Sync Health Board to monitor:

  • Average sync duration

  • Number of syncs

  • Sync success rate

  • API limit remaining

Getting There

Open the Sync Health Board tab in FieldFX Back Office.

Date Controls

Use the date controls to change the dates/times analyzed in the metrics.

Screenshot of the date control
Figure 1. Modify the date control to display the desired data

You can view data from the last 5 minutes up to the last four weeks.

Metrics

Sync Overview

Graph showing every successful and failed sync on all release channels in your org.

Screenshot of the sync graph
Figure 2. The Sync Overview graph displays successful and failed syncs in the selected date/time range
Move the mouse over spikes on the graph to view specific details.

Upload Errors

Graph showing every sync upload error on all release channels in your org.

Screenshot of the Upload Errors graph
Figure 3. The Upload Errors graph shows sync upload errors in your org
Move the mouse over spikes on the graph to view specific details.

Successful Downloads

Success rate of downloading data to FieldFX Mobile in your org.

Screenshot of the Successful Downloads metric
Figure 4. Review the percentage of downloads that successfully completed

Incremental Syncs

Number of incremental syncs in your org.

Screenshot of the Incremental Syncs metric
Figure 5. Review the number of incremental syncs in your org in the selected timeframe

Incr(emental) Sync Duration

Average duration of incremental syncs in your org.

Screenshot of the Incr Sync Duration metric
Figure 6. Average time users wait for an incremental sync to complete

LFW Avg Success

Success rate of syncs across all orgs using FieldFX.

Screenshot of the LFW Avg Success metric
Figure 7. See percentage of successful syncs of all types across all organizations using FieldFX

Full Syncs

Number of full syncs in your org.

Screenshot of Full Syncs metric
Figure 8. Total number of full syncs by users in your org

Full Sync Duration

Average duration of full syncs in your org.

Screenshot of the Full Sync Duration metric
Figure 9. Average length of a full sync in your org

Upload Success Rate

Success rate of uploading data to FieldFX Back Office in your org.

Screenshot of the Upload Success Rate metric
Figure 10. Percentage of successful uploads at your org

LFW Avg Sync Duration

Average duration of syncs across all orgs using FieldFX.

Screenshot of the LFW Avg Sync Duration metric
Figure 11. Length of time for an average sync across all orgs using FieldFX

Avg Sync Duration

Average duration of syncs in your org.

Screenshot of the Avg Sync Duration metric
Figure 12. Average length of a sync in your org

API Limit Remaining

Number of REST API calls remaining before you reach the limit for your org.

Screenshot of the API Limit Remaining Metric
Figure 13. Percentage of permitted REST API calls remaining for your org

Recommended Reading