Sync Engine Setup
Prerequisites
-
To set up the Sync Engine, you need the following licenses:
-
To set up the Sync Engine, you must:
-
To set up the Sync Engine, you need:
-
System permissions:
-
Customize Application
-
View Setup and Configuration
-
Metadata Caching
Basics
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:
-
Steve, a field user, does a Full sync at 8:00 AM on February 1.
-
The Sync Engine runs as normal.
-
-
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.
-
-
Chris, an admin, adds a custom field to the Job object at 11:00 AM.
-
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.
-
-
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.
-
Sync Job Crews
Basics
The Sync Job Crews feature gives you the ability to sync jobs based on crew planning assignments.
-
Users must be on the job crew to see a job in FieldFX Mobile.
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:
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? [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? [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? [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.
Figure 1. Flowchart of the decision process determining whether a job syncs -
When a job syncs, the following items sync along with the job:
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? [3]
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. [4]
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. [4]
Does the user have the price book assignment?
No
The price book does not sync.
Yes
The price book syncs. [4]
Figure 2. Flowchart of the decision process determining whether a price book syncs
Setting Up the Sync Job Crews Feature
Prerequisites
-
Set up sync configurations
-
Set up sharing rules for objects with data that syncs to FieldFX Mobile
Step 2: Configure FX Forms
-
Run scripts:
-
Open a new tab in your browser
-
Select Utilities → Apex Execute
-
Enter the following script:
Update [SELECT Id FROM FX5__eForm_Config__c]; -
Click Execute
-
Delete the previous script, then enter the following script:
System.debug(FX5.FXWorkerLauncher.DoWork('FX5.eFormJobPropagator', null)); -
Click Execute
-
-
Grant all users Read access to the Job Share and Sync Id fields on every FX Form object.
Step 3: Configure FX Settings
-
From Setup, enter "custom setting" in the Quick Find box, then select Custom Settings
-
Click Manage next to FX Settings
-
Click Edit
-
Select Sync v4 config
-
Click Save
Syncing 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.
-
Improve sync performance by opting out of downloading reports and attachments to mobile devices.
-
From Setup, enter
Custom Settingsin the Quick Find box, then select Custom Settings -
Select the FX Settings link
Do not select the Manage link next to FX Settings.
-
Click New to add a custom setting
-
Select Checkbox as the Data Type, then click Next
-
In Field Label and Field Name, enter
Sync_Download_Reports_Skip__c, then click NextField Name automatically populates with the Field Label entry.
-
Confirm the entries, then click Save
-
Click Manage to modify the FX Settings Custom Settings for your org
-
Click Edit to enable changes
-
Select the checkbox for
Sync_Download_Reports_Skip__c, then click Save
-