Sync Event Viewer
Introduction
The Sync Event Viewer is a sync administration tool available in the Admin Portal for orgs using the Auto Sync feature.
Use the Sync Event Viewer to resolve sync upload errors.
The ability to automatically upload data from FieldFX Mobile to FieldFX Back Office is still under development and requires setup not currently described in this documentation site. Contact support for more information. |
If your org has not enabled auto sync, use the Sync Health Board instead.
Prerequisites
To use the Sync Event Viewer, you need to:
Have these user licenses | Have these permissions | Complete these tasks and review these topics before continuing |
---|---|---|
See Permissions |
Permissions
Permission Set
For data to load to the Sync Event tool, assign the SyncEventPermissions and SyncEventDocumentPermissions permission sets to FieldFX Mobile users and admins. These permission sets grant the permissions detailed below.
The The permission set gives Read, Create, Edit, and Delete access to the Documents object, which is required for Auto Sync. |
System Administrators
To resolve sync upload errors in the Sync Event Viewer, you need:
FieldFX Mobile Users
To record your syncs in the Sync Event Viewer, you need:
Getting There
-
Go to https://admin.fieldfx.com and login with your Salesforce org credentials.
-
Click Sync Event Viewer.
-
Review the information in Unresolved Events Page, User Events Page, and Best Practices.
-
Continue with a task in Step-by-Step Guides.
The first time you access the Sync Event Viewer, the tool queries the entire history in the Audit Log. This may take an extended period of time to complete. When you come back to the tool again, the Sync Event Viewer loads quicker. |
Unresolved Events Page
The Unresolved Events page displays when you first log in.
This page features a list of users that have unresolved sync upload errors.
Sync upload errors are bundled together by user to make fixing errors easier.
Fields
The following fields display on the Unresolved Events page:
Field | Description |
---|---|
Count |
Number of unresolved sync upload errors |
Since |
Time elapsed since the first sync upload error occurred |
User |
User responsible for the activity |
User Events Page
The User Events page displays when you click View next to a user on the Unresolved Events page.
This page displays the unresolved sync upload errors for the specified user, sorted in chronological order.
You can see the events in information fields and their status indicators plus details
Use this page to resolve sync upload errors.
Events
An event is an action performed by a user.
Sync upload errors are always caused by an event.
This section covers event types, fields, event status indicators, event details, and FX Reports events.
Event Types
Following are the possible event types:
Event | Description |
---|---|
create Attachment |
User attached an FX Report to a record |
create FX5__Job__c |
User added a job |
update FX5__Job__c |
User edited a job |
create FX5__Ticket__c |
User added a ticket |
update FX5__Ticket__c |
User edited a ticket |
create FX5__Ticket_Item__c |
User added a ticket item |
update FX5__Ticket_Item__c |
User edited a ticket item |
delete FX5__Ticket_Item__c |
User deleted a ticket item |
create FX5__Quote__c |
User added a quote |
update FX5__Quote__c |
User edited a quote |
create FX5__Quote_Item__c |
User added a quote item |
update FX5__Quote_Item__c |
User edited a quote item |
delete FX5__Quote_Item__c |
User deleted a quote item |
create FXFORMNAMEHERE__c |
User added an FX Form |
update FXFORMNAMEHERE__c |
User edited an FX Form |
Fields
The following fields display on the User Events page:
Field | Description |
---|---|
Date/Time |
Date and time of the event that caused the sync upload error |
Tracking Number |
Tracking number of the record that caused the sync upload error |
Sync Id |
Last 8 digits of the Sync Id for the record that caused the sync upload error |
Type |
Type of event that caused the sync upload error |
Event Status Indicators
The Sync Event Viewer uses these indicators:
-
Errored
-
Modified
-
Ignored
-
Run From Here
Status Indicator | Description | ||
---|---|---|---|
Errored |
Displays the reason for the sync upload error. Figure 3. Hover the mouse over the error indicator to see a summary of the error
Hover over the exclamation mark icon to see the Salesforce error message. |
||
Modified |
Displays on events you have edited. Figure 4. A yellow banner displays on events that you have changed.
|
||
Ignored |
Displays on events you selected to ignore. Figure 5. Selected events are ready to be Ignored and display an indicator on the right of the event’s row
Select the checkbox next to an event to mark it to be ignored.
|
||
Run From Here |
Displays on events you choose to reprocess. Figure 6. Use the round radio button to select an individual event to reprocess
Select this indicator to reprocess all events.
|
Event Details
-
Click Details on an event to display the Event Details window.
The Event Details window displays the fields completed during an event.
Figure 7. Event Details displays information further information about the errored event -
Click Edit to make changes to the event data.
When editing an event, click X next to a field to remove it from the sync packet. -
Click Show Raw to view the event data in JSON (JavaScript Object Notation) form.
Click Edit to make changes to the event in JSON form. However, this is not recommended.
FX Reports
Click View on a create Attachment event to view the FX Report attached to a record during that event.
You can then print or save the report.
Best Practices
Remember to resolve each sync upload error individually before you reprocess a full list of events.
Step-by-Step Guides
Editing an Event
-
Click Details on the event.
-
Click Edit.
-
Make changes.
Click X next to a field to remove it from the event. -
Click Done.
-
Click Apply Changes.
The Modified Indicator now displays on the event.
Restoring a Deleted Record
-
Locate an event that features the deleted record.
-
Click the link to the deleted record.
-
Select the checkbox next to the deleted record.
-
Click Undelete.
Preprocessing Events
Preprocessing Events for User
-
Resolve the sync upload error(s):
-
Select the Errored indicator on the first event.
The error message displays.
Figure 8. Hover over the error message to display the error details -
Complete the following:
If… Then… and then… The error states that a record was deleted or no longer exists.
Proceed to step 2.
The error states that a field contains invalid data.
Correct the data.
There are no obvious issues with the fields or records in the event.
-
Repeat steps above until you resolve every sync upload error.
-
-
Delete events that should not reprocess:
-
Mark the checkbox for each event that should not reprocess.
-
Click X Delete Ignored.
-
-
Click Preprocess Events for User.