Sync Analytics
Introduction
|
To utilize these features, FX5 must be version 1.706 or later. |
Sync Analytics provides system administrators with detailed records of every sync performed by FieldFX Mobile (RN App) users in your org.
Use Sync Analytics to:
-
View sync history per user, including sync type, duration, and outcome
-
Identify slow syncs and the specific objects contributing to long sync times
-
Review per-object detail: rows transferred, request count, payload size, and errors
-
Track app version and operating system at the time of each sync
-
Run reports on sync activity across your org
|
Sync Analytics applies to the FieldFX Mobile (RN App) only. The legacy FieldFX web app does not generate sync log records. |
Prerequisites
To use Sync Analytics, you need to:
| Have these user licenses | Have these permissions | Complete these tasks and review these topics before continuing |
|---|---|---|
|
System Administrator or custom permission granting access to |
Access Sync Analytics
Open the Sync Analytics tab in FieldFX Back Office.
Alternatively, query the FX5__Mobile_Sync_Log__c and FX5__Mobile_Sync_Log_Details__c objects directly in Salesforce Reports or SOQL.
How Sync Analytics Works
Each time a FieldFX Mobile user syncs, FieldFX creates:
-
One Sync Log record (
FX5Mobile_Sync_Logc) — the header record for the sync event -
One or more Sync Log Detail records (
FX5Mobile_Sync_Log_Detailsc) — one child record per Salesforce object synced during that event
This two-level structure lets you see both the overall sync outcome and the per-object breakdown in a single view.
Sync Log Fields
The following fields are available on the FX5Mobile_Sync_Logc object:
| Field | Type | Description |
|---|---|---|
Name |
Auto-number |
System-generated record name |
User |
Lookup (User) |
The FieldFX Mobile user who performed the sync |
Sync Profile |
Text |
Name of the sync profile used during the sync |
Type |
Text |
Sync type: |
Sync Time |
Date/Time |
Date and time the sync occurred |
Duration |
Number |
Total duration of the sync in milliseconds |
Errors |
Long Text Area (32,768) |
Error details if the sync failed; blank if the sync succeeded |
Operating System |
Text |
Operating system of the device at the time of sync (added in FX26R1, FX5 version must be 1.690 or later) |
Version Number |
Text |
FieldFX Mobile app version at the time of sync (added in FX26R1, FX5 version must be 1.690 or later) |
UID |
Text (External ID) |
Unique identifier assigned by the mobile app |
|
Use the Operating System and Version Number fields (new in FX26R1) to correlate sync issues with specific app versions or device types. |
Sync Log Detail Fields
The following fields are available on the FX5Mobile_Sync_Log_Detailsc object:
| Field | Type | Description |
|---|---|---|
Primary SObject |
Text |
API name of the Salesforce object synced (for example, |
Rows |
Number |
Number of records transferred for this object |
Duration |
Number |
Time spent syncing this object, in milliseconds |
Number of Requests |
Number |
Number of API requests consumed for this object |
Size_KB |
Number |
Payload size for this object, in kilobytes |
Errors |
Long Text Area (32,768) |
Object-specific error details; blank if no errors occurred for this object |
UID |
Text (External ID) |
Unique identifier assigned by the mobile app |
In FX26R1, Sync Log Detail records are also created for the following download types, in addition to standard SObject rows:
| Detail Row Type | Description |
|---|---|
RTF fields |
Rich text field content downloaded to the device |
Layouts |
Mobile Object Layout definitions downloaded to the device |
Report templates |
FX Report template files downloaded to the device |
Sync Types
The Type field on the Sync Log record indicates what kind of sync the user performed:
| Type | Description |
|---|---|
|
First sync performed after the app is installed or after a full data reset |
|
User-initiated full sync that downloads all eligible records |
|
User-initiated incremental sync |
|
Automatically triggered incremental sync |
Sync Analytics Report
FieldFX includes a pre-built Salesforce report for Sync Analytics (added in FX26R1 and FX5 version must be later or equal to 1.706).
-
Location: Salesforce Reports > FX Error Log Reports folder
-
Default columns: Sync Time, Type, Created By, Duration, Sync Profile, Errors
-
Default sort: Sync Time (descending)
You can clone this report and customize it, or build your own reports directly on the FX5Mobile_Sync_Logc and FX5Mobile_Sync_Log_Detailsc objects.
Sync Log Retention
FieldFX automatically deletes Sync Log and Sync Log Detail records older than the configured retention period.
| Setting | Details |
|---|---|
Location |
Salesforce Setup > Custom Metadata Types > |
Default |
30 days |
Minimum |
1 day |
Mechanism |
Apex class |
No administrator action is required for log cleanup to run.
|
Setting |
Sync Links and Sync Analytics
Starting in FX26R1, when a sync link is created for a Job, FieldFX automatically creates sync links for the associated Quote (FX5 version is 1.708 or newer) and Price Book (FX5 version is 1.725 or newer).
This means that after upgrading to FX26R1, you may see additional Sync Log Detail rows for users who previously only showed FX5__Job__c download entries.
The following additional detail rows are now expected:
| New Detail Row | Reason |
|---|---|
|
Automatically synced when a Job sync link is created (FX5 version must be 1.708 or later). |
|
Automatically synced when a Job sync link is created (FX5 version must be 1.725 or later). |
|
View Sync Log JSON
The Sync Log item viewer renders sync packet JSON in a collapsible tree component (added in FX26R1). This makes large sync payloads and error details easier to read and navigate without scrolling through raw text.
To view the JSON tree for a sync log entry:
-
Open the Sync Analytics tab in FieldFX Back Office.
-
Select a Sync Log record.
-
Click the sync packet entry you want to inspect.
The JSON tree displays with expandable and collapsible nodes.
For reprocessing sync packets with upload errors, see Packet Viewer.
Diagnose Slow Syncs
Use the Sync Log Detail records to identify which objects are contributing to long sync durations.
-
Open the Sync Analytics tab.
-
Filter or sort by Duration (descending) to find the slowest syncs.
-
Open a slow Sync Log record and review its child Sync Log Detail records.
-
Check the Duration and Rows fields on each detail row to identify the object consuming the most time.
-
Compare the Number of Requests and Size_KB values to identify unexpectedly large payloads.
|
For org-wide sync performance trends (average duration, success rate, API limit remaining), use the Sync Health Board. For diagnosing individual sync upload errors, use the Sync Event Viewer. |
Recommended Reading
For more information, see:
| FieldFX Documentation | Salesforce Documentation |
|---|---|
|
None |