Sync Wizard
Introduction
You can use the Sync Wizard to create Sync Profiles to assign to field users. Sync Profiles determine the objects and fields that sync to assigned users' mobile devices. The profiles created in the Sync Wizard can manage what syncs for multiple users, similar to how User Profiles manage permissions to objects and fields.
Prerequisites
To setup and use the Sync Wizard Admin Portal Tool, you need to:
| Have these user licenses | Have these permissions for System Administrators | Complete these tasks and review these topics before continuing |
|---|---|---|
|
How Sync Wizard Works
Use the Sync Wizard tool to create a Sync Profile.
You can assign a Sync Profile to field users.
|
Add the Mobile Sync Profile field to the User object’s page layout first. |
If you are an Admin, you can use the Sync Reset Option in Setup > Object Manager > User > Fields & Relationships > Sync Reset Option with one of these options:
-
Force Logout - deletes any unsynced data and logs the user out
-
Upload and Logout - retrieve the users unsynced data and log the user out
-
Reset Data - clear the mobile storage begin a full sync
After assigning a sync profile to a user, the sync packet that downloads to FieldFX Mobile only includes the objects, fields, and attachments for syncable records specified in the user’s assigned Sync Profile.
|
Whether an individual record is syncable is determined by other factors and not only by the sync profile. Those factors include:
|
Keep these factors in mind:
-
Permission sets and Profiles grant access for users to access any data in objects and fields. With no permission at this level, no data from the object or field is available to the user anywhere.
-
Sharing rules determine whether users have any access to a particular record in either FieldFX Back Office or FieldFX Mobile.
-
Sync and AltSync rules determine whether a particular record should be available on mobile devices for any user.
-
Sync Configuration records determine whether a particular user needs access to a record on their mobile device based on criteria specific to that user.
-
When all four of the above are true, the Sync Profile determines what subset of objects, fields, and attachments should download to the user’s mobile devices.
-
Step-by-Step Guides
With the Sync Wizard, you can:
Create the Default Sync Profile
-
Go to admin.fieldfx.com and log in to the desired production or sandbox org.
-
Select Sync Wizard.
-
Select Start Wizard.
The first time you use the Sync Wizard, you must first create a Default Sync Profile.
After creating the Default Sync Profile, you can create additional profiles and are prompted to customize the profile’s name.
-
Select Let’s Get Started.
-
In Sync Mode, select the types of devices for this group of users, then click Next.
Dedicated Mode:
Users each have their own device that is not shared by other users.
FieldFX recommends dedicated devices for field users. Shared Mode:
A device may be used by multiple users, such as between shifts.
-
Select the type(s) of records (objects) users either add or modify on their devices, then click Next.
Be sure to only select the type(s) the set of users for this Profile add or modify on their devices.
If they only view the records, do not select the checkbox.
Example 1. Appropriate Types by Job FunctionField technicians do not add or modify quotes while sales people likely do not add or modify tickets or work orders.
-
Select whether members of Job Crews should only sync the crew’s jobs and related price books, then click Next.
-
In Synced Objects, review the objects the wizard determined should sync for these users and make any desired adjustments by selecting or deselecting objects.
Data from objects that are not selected do not sync to mobile devices for users assigned to this Sync Profile.
The selected options do not change any user’s permissions to the object or access to individual records or fields in the object.
Users must also have permission to the object from their User Profile or at least one Permission Set for data from the object to sync!
To display each object’s API name, select the Show Details checkbox.
-
After making the selections for Synced Objects, the Sync Wizard runs a query to search for required fields, then presents a series of screens to determine what fields to sync for specific objects.
Master data objects display first, then transactional objects.
To see the API names for fields, select the Show Details checkbox.
Recommended fields are pre-selected, but can be removed if not needed on mobile devices. Fields required for syncing display in a separate group at the bottom of the page and cannot be deselected.
The selected options do not change any user’s permissions to fields on the object. Users must have permissions to the selected fields from a User Profile or at least one Permission Set to sync data for the field.
-
Make any desired changes to the selected fields for the displayed object, then click Next. Repeat for each additional object.
Not all objects display.
The query that runs after selecting the objects to sync also tests the size of the fields and number of records on an object.
The Sync Wizard doesn’t have a selection screen for an object if syncing the fields from that object doesn’t add significant size to the sync packet.
-
Click Finish to exit the wizard.
Create an Additional Sync Profile
-
From the Sync Wizard’s Sync Configuration screen, select Create config.
-
Enter a Config Name, then select Create.
-
Select Let’s get started! and complete the wizard as described from step 5 in Create The Default Sync Profile above.
Manage Existing Sync Profiles
-
From the Sync Wizard’s Sync Configuration screen, select the desired Active Config from the dropdown.
-
Enter a Config Name, then select Create.
-
Select the option to modify from the menu on the left.
The menu lists synced master data objects, then groups Transactional and Lookup Objects. Option Action Wizard
Make changes by repeating the configuration wizard
Overview
Modify the Sync Mode, Editable Objects, and whether users Download Reports
Job and Pricebook Dispatch
Manage whether to use sync configurations to filter what syncs and review existing sync configurations
Price Books
Manage the fields that sync for Price Books
Price Book Items
Manage the fields that sync for Price Book Items
Synced Objects
Change which objects sync to mobile devices
Transactional Objects
Display the list of transactional objects that sync and manage the fields for those objects
Click the Back option in the next menu to return.
Lookup Objects
Display a list of lookup objects that sync and manage the fields for those objects
Click the Back option in the next menu to return.
Raw Config
View the contents of the static resource file for the sync configuration profile
-
Make changes and review any Sync Issues alerts by hovering over the red button.
-
Select Save before navigating to a different option.
Add Sync Profile
Once you have created the new Sync Profile, it needs to be made available for selection. The process involves adding the new sync profile to the Mobile Sync Profile Custom Metadata Type and then select the sync profile to the user’s record.
Add the Mobile Sync Profile Value to the Mobile Sync Profile Value in the User Object
-
In your org’s Setup, enter
Objectin the Quick Find box. -
Select Object Manager.
-
In the Quick Find box, enter
User. -
Select User and then Fields & Relationships.
-
In the Quick Find box, enter
mobile. -
Select Mobile Sync Profile.
-
In Mobile Sync Profile (Managed), scroll down to the Values section.
-
Select New and then add the name of the sync profile you created as a picklist value.
For the name, use underscores instead of spaces.
Example: Sync Profile Name must be Sync_Profile_Name
Click Save.
Each value should be on its own line and it is used for both a value’s label and API name. If a value matches an inactive value’s API name, that value is reactivated with its previous label. If a value matches an inactive value’s label but not the API name, a new value is created. -
Continue with adding the sync profile to the user.
Add Sync Profile to User
-
In your org’s setup, type
userin the Quick Find box. -
Select Users.
-
In Users, click Edit next to the profile that needs access to the sync profile.
-
In the user’s record, scroll down to the FieldFX section.
-
Click in the Mobile Sync Profile dropdown and select the sync profile.
-
Click Save.
Now that user can log into the FieldFX Mobile App.
Manage Filters
You can add filters to objects as an additional layer to manage what syncs to mobile devices.
Filters use the AltSync flag on objects, which must be True for a record to sync.
| Filters must be changed from the Default Config Sync Profile, as the filter is an object-level setting that applies to everyone. |
-
Access the Sync Configuration Wizard Admin Portal tool.
-
Select Default Config from the Active Config dropdown.
The filter options selected for the Default Config Sync Profile apply to all Sync Profiles.
-
Select the desired object from the menu.
-
If necessary, select the
arrow to expand the Filter records section. -
Select one of the following options:
Option Object
AvailabilityAction No filter
Do not use AltSync for this object
Filter rows by activity
only
Master Data
and LookupLet FieldFX automatically select or deselect the AltSync flag on records
Filter rows manually
only
TransactionalUse the AltSync flag, but a person selects and deselects the flag on records as needed
Filter rows by formula:
Enter a SOQL statement in the AltSync Formula field that must evaluate to
Truefor the record to sync.Many objects have a recommended SOQL formula to use.
Alerts display if the recommended setting is not entered, and the recommended formula displays in the Recommended AltSync Formula field that can be copied into the AltSync Formula field.
-
Select Save, then repeat for other objects as needed.
