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 SyncEventDocumentPermissions permission set is created automatically as part of installing FieldFX Base Managed Package 1.414.

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:

Object Permissions

Object Read Create Edit Delete View All Modify All

Documents

Green Check

Green Check

Green Check

Green Check

Sync Event

Green Check

Green Check

Green Check

Field Permissions

Object Field Read Edit

Sync Event

All Fields

Green Check

Green Check

FieldFX Mobile Users

To record your syncs in the Sync Event Viewer, you need:

Object Permissions

Object Read Create Edit Delete View All Modify All

Documents

Green Check

Green Check

Green Check

Green Check

Sync Event

Green Check

Green Check

Green Check

Green Check

Field Permissions

Object Field Read Edit

Sync Event

All Fields

Green Check

Green Check

Back to Top

Access the Sync Profile Viewer

Access the Admin Portal

Inside of FieldFX Back Office, the Admin Dashboard accesses the FieldFX Admin Portal.
Click to expand

  1. Access the Admin Portal either by:

    1. Open a browser tab to admin.fieldfx.com and log into the org with your system credentials.

    2. In FieldFX Back Office,

      • Click on Launcher icon and type admin.

      • Select Admin Dashboard.

        The Admin Dashboard tab appears along the top of the nav bar as the last item.

    3. Click Add X Nav Item(s).

    4. Move the newly added nav item by clicking on the item and dragging the move icon up or down on the list. If you want to add more items, repeat the steps above.

    5. When in position, click Save.

      A browser toast message appears that the nav item was added.

  2. To save the Admin Dashboard tab as a permanent tab,

    1. click Pencil icon to open the navigation items edit box.

      The name in the title differs depending on the FieldFX module you are in. If you switch FieldFX modules, the nav item won’t appear. Repeat these steps to add the Admin Dashboard tab to the FieldFX module you are in.

    2. Click Add More Items.

    3. Click Available Items > All

    4. Click Admin Dashboard.

      A green check appears next to Admin Dashboard item and a "Admin Dashboard" pill appears below the search field. The number of items selected is also displayed.

      Add Top Nav Item selection

Review Events

  1. Access the Admin Portal and login with your Salesforce org credentials.

  2. Click Sync Event Viewer.

  3. Review the information in Unresolved Events Page, User Events Page, and Best Practices.

  4. 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.

Screenshot of the Unresolved Events page
Figure 1. Unresolved Events provides a summary view

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

Buttons

The following buttons display on the Unresolved Events page:

Button Description

Delete Ignored

Deletes the selected event(s)

Refresh

Refreshes the page

View

Displays the user’s unresolved sync upload errors

Back to Top

User Events Page

The User Events page displays when you click View next to a user on the Unresolved Events page.

Screenshot of the Unresolved Events for a user
Figure 2. Click View to display a list of the events for the user

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.

Animation of hovering over the error indicator icon
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.

Screenshot of the yellow modified banner on an event
Figure 4. A yellow banner displays on events that you have changed.

Ignored

Displays on events you selected to ignore.

Animation of selecting a checkbox and the Ignored banner appearing
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.

After selecting the event(s) to ignore, click X Delete Ignored at the bottom of the screen.

Run From Here

Displays on events you choose to reprocess.

Animation of selecting the radio button for an event and seeing the Run From Here button display
Figure 6. Use the round radio button to select an individual event to reprocess

Select this indicator to reprocess all events.

Refer to the Preprocessing Events guide below for detailed instructions.

Event Details

  1. Click Details on an event to display the Event Details window.

    The Event Details window displays the fields completed during an event.

    Screenshot of an Event Details for a sync error event
    Figure 7. Event Details displays information further information about the errored event

  2. 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.

  3. 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.

Back to Top

Best Practices

Remember to resolve each sync upload error individually before you reprocess a full list of events.

Back to Top

Step-by-Step Guides

Editing an Event

  1. Click Details on the event.

  2. Click Edit.

  3. Make changes.

    Click X next to a field to remove it from the event.

  4. Click Done.

  5. Click Apply Changes.

    The Modified Indicator now displays on the event.

Exporting an FX Report from an Event

  1. Locate the create Attachment event for the report.

  2. Click View on the event.

  3. Save the report.

Restoring a Deleted Record

  1. Locate an event that features the deleted record.

  2. Click the link to the deleted record.

  3. Select the checkbox next to the deleted record.

  4. Click Undelete.

Preprocessing Events

Preprocessing Events for User

  1. Resolve the sync upload error(s):

    1. Select the Errored indicator on the first event.

      The error message displays.

      Animation of hovering over the errored indicator and displaying the error message
      Figure 8. Hover over the error message to display the error details

    2. Complete the following:

      If…​ Then…​ and then…​

      The error states that a record was deleted or no longer exists.

      Restore the deleted record.

      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.

    3. Repeat steps above until you resolve every sync upload error.

  2. Delete events that should not reprocess:

    1. Mark the checkbox for each event that should not reprocess.

    2. Click X Delete Ignored.

  3. Click Preprocess Events for User.

Deleting Ignored Events

  1. Select the checkbox next to events you don’t want to process.

    Animation of selecting a checkbox and the Ignored banner appearing
    Figure 9. Selected events are ready to be Ignored and display an indicator on the right of the event’s row

  2. Click Delete Ignored.

    The events now display in gray and will disappear once you next refresh the page.

Recommended Reading

Back to Top