Sync Engine Setup

Prerequisites

To set up the Sync Engine, you need to:

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

Metadata Caching

Syncing metadata can take up to 50% of the time it takes to sync.

The Metadata Caching feature gives you the ability to skip syncing metadata for a defined period, resulting in faster syncs during that period.

If you don’t set up this feature, metadata will download during every sync.

How it Works

Consider the following series of syncs, where the Metadata Caching feature is configured to skip syncing metadata for 24 hours:

How the 24-hour metadata cache behaves

  1. Steve, a field user, does a Full sync at 8:00 AM on February 1.

  2. Steve does an Incremental sync at 10:00 AM.

    • Since it has only been 2 hours since metadata last synced, the Sync Engine doesn’t download any metadata.

  3. Chris, an admin, adds a custom field to the Job object at 11:00 AM.

  4. Steve does an Incremental sync at 1:00 PM

    • Since it has only been 5 hours since metadata last synced, the Sync Engine doesn’t download any metadata.

    • The new field doesn’t display in Mobile.

  5. Steve does an Incremental sync at 10:00 AM on February 2.

    • Since it has been more than 24 hours since metadata last synced, the Sync Engine downloads metadata.

    • The new field now displays in Mobile.

Configuring the Metadata Caching Feature

  1. Access FieldFX Back Office.

  2. Switch to Salesforce Classic.

  3. From Setup, enter custom setting in the Quick Find box, then select Custom Settings.

  4. Click Manage next to FX Settings.

  5. Click Edit.

  6. In SyncMetadataCacheDurationMinutes, enter the time in minutes in which to skip syncing metadata.

    • Enter "720" to skip syncing metadata for 12 hours.

    • Enter "1440" to skip syncing metadata for 24 hours.

    • Enter "0" to always sync metadata.

  7. Click Save.

Sync Job Crews

The Sync Job Crews feature gives you the ability to sync jobs based on crew planning assignments.

This gives you greater control over the job data that syncs to FieldFX Mobile.

Sync Rules

Jobs

When you enable the Sync Job Crews feature, the following rules control when jobs sync:

This rule overrides Crew Planning eligibility and this admin intent takes precedence over all other sync logic.
Access Check Question Result Action

Is the user assigned to the job crew?

No

Job does not sync

Yes

Proceed to the Sync access check question.

Is the Job’s Sync field selected?
(see Note 1)

No

Job does not sync

Yes

Proceed to the Record Ownership access check question.

Does Record Ownership grant the user access to the record?
(see Note 2)

No

Proceed to the Sharing settings access check question

Yes

Proceed to the AltSync use access check question

Do Sharing settings grant access to the record?
(see Note 3)

No

Job does not sync.

Yes

Proceed to the AltSync use access check question

Is AltSync defined for the record’s object?

No

The job syncs.

Yes

Proceed to the AltSync selected access check question

Is the job record’s AltSync flag selected?

No

The Job does not sync.

Yes

The Job syncs.

Table Notes

  1. This flag is handled automatically by FieldFX.

  2. You own and have access to all Jobs you add. You can access jobs owned by or shared with users below you in the role hierarchy unless Grant Access Using Hierarchies is deselected on the Job object.

  3. A record is shared if the default on the Job object is set to Public Read/Write. Alternatively, set the org-wide default to Private and define sharing rules.

Flow
Flowchart showing the process of questions evaluated for whether a job should sync
Figure 1. Flowchart of the decision process determining whether a job syncs

When a job syncs, the following items sync along with the job:

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.

Price Books

When you enable the Sync Job Crews feature, the following rules control when price books sync:

Access Check Question Result Action

Do Sharing settings grant access to the record?
(see Note 1)

No

The price book does not sync.

Yes

Proceed to the AltSync defined access check question

Is AltSync defined for the record’s object?

No

Proceed to the Global price book question.

Yes

Proceed to the AltSync flag access check question

Is the price book’s AltSync flag selected?

No

The price book does not sync.

Yes

Proceed to the Global price book question

Is this a Global price book?

No

Proceed to the linked job access check question.

Yes

The price book syncs.
(see Note 1)

Is the price book linked to a job that syncs?

No

Proceed to the price book assignment access check question.

Yes

Proceed to the job crew access check question.

Is the user assigned to the Job crew?

No

Proceed to the price book assignment access check question.

Yes

The price book syncs.
(see Note 1)

Does the user have the price book assignment?

No

The price book does not sync.

Yes

The price book syncs.
(see Note 1)

Table Notes

  1. A record is shared if the default on the Price Book object is set to Public Read/Write. Alternatively, set the org-wide default to Private and define sharing rules.

In FieldFX, price books sync only through jobs, and only when crew assignment, job sync flags, record access, sharing rules, and (if used) AltSync selection all pass—unlike other data that syncs once per profile.

Set Up the Sync Job Crews Feature

Prerequisites

Step 1: Configure Jobs

  1. Grant all users Read access to the Job lookup on the following objects:

    • Ticket Checklist Step

    • Ticket Item

    • Ticket Log

Step 2: Configure FX Forms

  1. Run scripts:

    1. Open a new tab in your browser.

    2. Access Workbench.

    3. Select Utilities → Apex Execute.

    4. Enter the following script:

      Update [SELECT Id FROM FX5__eForm_Config__c];

    5. Click Execute.

    6. Delete the previous script, then enter the following script:

      System.debug(FX5.FXWorkerLauncher.DoWork('FX5.eFormJobPropagator', null));

    7. Click Execute.

  2. Grant all users Read access to the Job Share and Sync Id fields on every FX Form object.

Step 3: Configure FX Settings

  1. Access FieldFX Back Office.

  2. Switch to Salesforce Classic.

  3. From Setup, enter custom setting in the Quick Find box, then select Custom Settings.

  4. Click Manage next to FX Settings.

  5. Click Edit.

  6. Select Sync v4 config.

  7. Click Save.

Sync Reports and Attachments

Sync performance can be greatly impacted when users have a large number of reports and attachments to download to their mobile device for their syncable records.

You can improve sync performance by opting out of downloading reports and attachments to mobile devices.

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

  2. Select the FX Settings link.

    Do not select the Manage link next to FX Settings.

  3. Click New to add a custom setting.

  4. Select Checkbox as the Data Type, then click Next.

  5. In Field Label and Field Name, enter Sync_Download_Reports_Skip__c, then click Next.

    Field Name automatically populates with the Field Label entry.

  6. Confirm the entries, then click Save.

  7. Click Manage to modify the FX Settings Custom Settings for your org.

  8. Click Edit to enable changes.

  9. Select the checkbox for Sync_Download_Reports_Skip__c, then click Save.