Syncing Data

Introduction

The act of synchronizing data between FieldFX Mobile and FieldFX Back Office is a called "sync". It is part of the FieldFX Sync Engine and can also be used with FX EAM (Enterprise Asset Management) and Work Orders in FieldFX.

  • You must sync data regularly in FieldFX Mobile to stay up-to-date.

  • FX Mobile Users must have access to the OmnibusRestService and the PreSyncController Apex classes. If not, they will receive this error when trying to sync:
    ERROR: Configuration Error: invalid type or missing access to FX5Sync_Eventc CAUSE: User Account Configuration Error

There are three types of sync:

Type Duration Occurs Downloads Uploads

Full

Longer
Downloads every record and syncable attachment you have access to

After you:

  • Log in

  • Clear the browser cache

  • Accessible records

  • Syncable attachments

-

The Attachments feature in FieldFX has been deprecated and replaced with the Files API. To upload files to tickets or jobs, make sure the FXL File Viewer Lightning Components is added to the ticket or job record page.

Follow the steps in Set Up Attachments Using the Files API.

Incremental

Shorter
Only download and upload changes made since the last sync

When you select Sync

  • New records

  • Record updates

  • New attachments

  • New records

  • Record updates

  • New attachments

Upload

Available on the Sync 4.0 release channels only

A few seconds
Only upload changes made since the last sync

When you select Upload Only

-

  • New records

  • Record updates

  • New attachments

Prerequisites

To setup and sync data, you need to:

Have these user licenses Have these permissions Complete these tasks
and review these topics
before continuing

or

or

In addition:

Review the following: Complete these tasks:

Sync Rules

Sync rules control when records and attachments sync:

Pre-Sync Check

A pre-sync check runs every time you sync.

  • If you pass the check, the sync runs as normal.

  • If you fail the check, the sync fails instantly and a message displays what you are missing.

This check determines whether you have the following:

  • FieldFX Base Package license

  • FX E-Ticketing license

  • Contact linked to your user record

  • Read, Create, and Edit permission for the Audit Log object

  • Read and Edit permission for every managed field on the Audit Log object

  • Permission to use the FX5.Field Ticketing app

  • Permission to execute the following Apex classes:

    • FX5.FieldSetSvc

    • FX5.GetUtilityUserInfo

    • FX5.SObjectChecksum

Best Practices

You can use these best practices to make the most out of FieldFX’s Sync 4.0:

  • Sync data at least once a day

  • Don’t sync repeatedly as there is a limit to the amount of data you can sync in a 24-hour period.

    Refer to the API Limits article for further details

  • Wait for a sync to finish before you log out, close FieldFX Mobile, or go offline

    If you don’t wait for a sync to finish, you won’t be able to use FieldFX Mobile until you finish the sync.

  • If you encounter a problem during a sync:

    • Contact your system administrator immediately

    • Don’t sync again

    • Don’t log out, close FieldFX Mobile, or close the FieldFX Mobile

    • Don’t open FieldFX Mobile in another tab or browser window

    • Don’t clear the browser’s cache

    • Don’t uninstall and reinstall the shortcut for FieldFX Mobile

    • Don’t switch off your device

Step-by-Step Guides

Sync Pending Changes and Download Updates

Complete the following to sync changes you made since the last sync and download updates from FieldFX Back Office.

  1. Connect to the internet.

  2. Select FX.

    FX Mobile’s FX button

  3. Select Sync.

    The Sync button turns into a progress bar.

    FX Mobile’s sync in progress bar

    Select the Down arrow in the Sync Details section to view diagnostics.

    Use the diagnostics to see how many records are downloading from FieldFX Back Office and to see how your sync is progressing.

    FX Mobile’s sync details panel with progress bars

Sync Pending Changes Only

Prerequisite

Available on the Sync 4.0 release channels only.

Complete the following to sync changes you made since the last sync, without downloading anything from FieldFX Back Office.

  1. Connect to the internet.

  2. Select FX.

    FX Mobile’s FX button

  3. Review Pending Changes.

    The Pending Changes list displays changes you made on the device since the last sync.
    FX Mobile’s pending changes section

  4. Select Upload Only.

    FX Mobile’s Upload Only button