Auto Sync Setup

Introduction

You can set up Auto Sync to automate upload syncs from FieldFX Mobile to FieldFX Back Office.

Downloading from FieldFX Back Office to FieldFX Mobile already occurs automatically at specified intervals.

Admins can troubleshoot sync packet issues with the Admin Portal’s Sync Event Viewer tool for the upload portion of Auto Sync. They can also resolve Sync Upload Errors with the Packet Viewer in the Audit Log.

Prerequisites

To setup Auto Sync, you need to:

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

Considerations

  • The org must enable attachments through the Files API, as Auto Sync relies on the Files API for the automatic syncing of data.

    Auto Sync does not use or support either Chatter or Notes & Attachments lists. All reports and files that sync do so through the Files API.

  • Field users must have an active and available Internet connection for data to sync. Offline data automatically syncs when an Internet connection becomes available.

How Auto Sync Works

  1. When a FieldFX Mobile user makes a change, the field device automatically initiates the sync process as soon as the change is complete.

    FieldFX Mobile waits three seconds after a user completes one change in case they also make another change.

    If a field user does not have an available Internet connection, the changes are stored until a connection becomes available. Queued changes automatically upload when a connection is reestablished.

  2. Events in the sync load to the FX5__Sync_Events__c object from the mobile device.

  3. Apex code runs to process the events, marking successfully synced events for deletion.

    The code processes the events according to the size of each event:

    1. For events under the batch size, events are processed synchronously.

    2. For events over the batch size, events are processed asynchronously using the batching API from Salesforce.

  4. A nightly process removes events marked for deletion.

    The FX5__SyncEventKeptHistoryInDays__c custom setting controls how long to keep events marked for deletion. The default is 40 days.

  5. Review failed events in the Sync Events Viewer in the Admin Portal (admin.fieldfx.com).

Step-by-Step Guides

  1. Enable attachments through the Files API.
    Auto Sync relies on the Files API for the automatic syncing of data.

    Auto Sync does not use or support either Chatter or Notes & Attachments lists. All reports and files that sync do so through the Files API.

  2. Configure page layouts and train FieldFX Back Office users in how to work with attachments using the Files API.

  3. Complete the following:

Create a Boolean Checkbox Custom Setting in FX Settings

  1. From Setup, enter Custom Settings in the Quick Find box, then click Custom Settings.

  2. Click FX Settings.

  3. Click New next to Custom Fields.

  4. Select Checkbox, then click Next.

  5. Make the following entries:

    Entry Option

    Field Label:

    EnableAutoSync

    Default Value:

    Checked

    Field Name:

    EnableAutoSync

    This defaults in if you entered the Field Label as above.

    This must be entered exactly as listed.

    Description (optional):

    Enables automatic sync upload from FieldFX Mobile to FieldFX Back Office

  6. Click Next, then click Save.

  7. Continue with Verify the Sync Packet Size in FX Settings.

Back to Step-by-Step Guides

Verify the Sync Packet Size in FX Settings

  1. From Setup, enter Custom Settings in the Quick Find box, then click Custom Settings.

  2. Click FX Settings.

  3. Click Manage.

  4. Scroll down to the Sync Packet Size field and verify the value.

  5. If necessary, click Edit, update the Sync Packet Size value, then click Save.

    If you are having issues, set the Sync Packet Size value to 10.
    If that doesn’t work, set the value to 5.

  6. Add the Sync Events Permissions and SyncEventDocumentPermissions Permission Sets to all Field Users and Admins.

    As an alternative, add both permission sets to the Permission Set Groups you use for Field Users and System Administrators.

    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.

  7. Continue with Manage the Permission Sets.

Back to Step-by-Step Guides

Manage the Permission Sets

  1. From Setup, enter Permission Sets in the Quick Find box, then click Permission Sets.

  2. Click the S to filter the list of permission sets to those that begin with the letter S, then click SyncEventPermissions.

  3. Click Manage Assignments.

  4. Click Add Assignments.

  5. Select the checkbox next to each Field User and Admin, then click Assign.

  6. Click Done when all users have been assigned.

Back to Step-by-Step Guides

Recommended Reading