Sync Engine

Introduction

The Sync Engine is one of the most important features in the FieldFX product suite.

The Sync Engine synchronizes data between FieldFX Mobile and FieldFX Back Office.

Graphic overview of FieldFX Mobile and FieldFX Back Office

The Sync Engine can be used with FX EAM (Enterprise Asset Management) and also used in Work Orders.

Prerequisites

To use the Sync Engine, you need to:

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

or

or

How the Sync Engine Works

The act of synchronizing data between FieldFX Mobile and FieldFX Back Office is a called "sync".

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

There are three types of sync:

Type Occurs Downloads Uploads

Full

This takes more time to complete because they download every record and syncable attachment you have access to.

After you log in and clear the browser cache

  • Accessible records

  • Syncable attachments

n/a

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

This takes less time to complete because they 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

This takes a few seconds to complete because they only upload changes made since the last sync.

Available on the Sync 4.0 release channels only

When you select Upload Only

n/a

  • New records

  • Record updates

  • New attachments

Sync Engine Features

The FieldFX Sync Engine has these features:

Sync Rules

Sync rules control when records and attachments sync.

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.

Back to Sync Engine Features

Auto Sync

The Auto Sync feature syncs changes made in FieldFX Mobile up to FieldFX Back Office automatically. You can learn how to set up the Auto Sync feature. Users save time completing work in the field by not worrying about forgetting to sync at the end of day.

The Auto Sync feature runs automatically when users are online. Any changes made when offline sync automatically the next time the user is online.

Sync 4.0

Sync 4.0 is the latest version of the Sync Engine.

Back to Sync Engine Features

Release Channels

A release channel hosts a version of FieldFX Mobile.

Your release channel controls the Sync Engine
used in FieldFX Mobile:
Sync Engine 4.0 Sync Engine 3.0

Sync V4 Beta

Beta Bi-Weekly

Sync V4

Bi-Weekly

Sync V4 Quarterly Beta

Quarterly Beta

Sync V4 Quarterly

Quarterly

For more information, see the sync rules for records.

Back to Sync Engine Features

Sync Health Board

The Sync Health Board is a dashboard displaying real-time metrics about sync performance.

Use the Sync Health Board to monitor:

  • Average sync duration

  • Number of syncs

  • Sync success rate

Back to Sync Engine Features

Reducing Sync Times

Permissions & Record Access

Permissions and record access both affect sync times.

To reduce sync times:

Field Types

Field types also affect sync times.

To reduce sync times:

Recommended Reading