Edit a Sync Profile

Once a sync profile is created, you can edit it to customize what modules it can access, its settings, Transaction Objects, and Lookup Objects.

Edit Sync Profile callouts
Callout Name Description

1

Modules

Select which modules users of the sync profile can see in Mobile.

Users with this sync profile can see these modules:

  • Jobs - The user can view and interact with Jobs in FieldFX

  • Tickets - The user can view and interact with Tickets in FieldFX

  • Overrides - Check this box to allow the sync profile to have access to override records in the Mobile app. This includes override records for Jobs, Tickets, and Eforms

  • Work Orders - The user can view and interact with Work Orders in FieldFX.

2

Landing Pages

The default page that users using the sync profile sees when logging into Mobile.

Users with this sync profile see this module upon logging in:

  • None (default)

  • Jobs

  • Tickets

  • Work Orders

3

Settings

Use these checkboxes to limits the data synced to a mobile user based on their active crew or job assignment records:

  • Filter by Sync Assignment - Filter the sync profile by sync assignment

  • Allow File Deletion - Select to allow the sync profile to delete files from a job or ticket.

    You can enable users with a specific Sync Profile to delete files.

4

Transaction Objects

A list of transaction objects that users of the sync profile can access in Mobile. The list is based on the modules selected above.

The objects are shown in a table with the following columns:

  • Sync: Select to have records from the transaction object sync between Back Office and Mobile.

    When using DataGuide Forms, the Form Data checkbox must be selected for the Sync Profile that needs access. If not, checked, the mobile user doesn’t see the DG Forms. If you select it (and it was unselected), you will need to resend the Sync Staged Data. The mobile user will see any forms attached when they next log in.

  • Edit: Selecting this checkbox grants the sync profile edit access to the records generated by the transaction object. This determines whether users can modify existing records or create new records for that object in the FieldFX Mobile App.

    Turning the Edit access on and off resets the object’s layout assignments to Default.

  • Create: Selecting this checkbox allows the sync profile to create records in the transaction object. This determines whether users can modify existing records or create new records for that object in the FieldFX Mobile App.

  • Delete: Selecting this checkbox allows the sync profile to delete the records generated by the transaction object.

  • Rows Synced: Shows the number of records from that transaction object that are synced to Mobile based on the current sync profile settings. This number is based on the last sync and can be used for troubleshooting.

If the object isn’t used, No Rows is shown. If the object doesn’t sync, Not Synced is shown.

5

Rows Synced

The estimated number of records this object will sync to mobile devices for this sync profile.

Table 1. Rows Synced actions
Rows Synced shows Meaning Action

Not Synced

The object has not been synced to Mobile.

Check the sync profile settings and ensure the object is included in the sync.

Green Number

Estimated number of records that currently match the sync profile criteria.

The object has been successfully synced to Mobile.

The estimated count is below the 200,000 warning threshold.

No action is required.

Red Number with an icon

Estimated number of records that currently match the sync profile criteria.

The object has been synced to Mobile, but the row count exceeds the maximum of 200,000.

Check the sync profile settings and consider reducing the number of records to sync. Tighten the criteria for the records to be synced if necessary. The profile can still be saved.

No Rows with an icon

No records currently match the sync profile criteria.

Verify that the object is included in the profile and that the filter criteria are correct.

MALFORMED_QUERY in red with an icon (object names also red)

The filter query is invalid and cannot be executed.

Hover over the value to view the error details, then correct the query.

The profile cannot be saved until the error is resolved.

Hover details for a malformed query

A filter icon next to an object name means it has a custom filter. Hover over the icon to see the filter details.

6

Module Tabs

Use this area to arrange the tabs a mobile users sees if they are viewing:

  • Jobs - The user can view and interact with Jobs in FieldFX.

  • Tickets - The user can view and interact with Tickets in FieldFX.

  • Work Orders - The user can view and interact with Work Orders in FieldFX.

Click the arrow icons next to the tab name to move it left or right in the FieldFX Mobile App interface.

The first tab is the default landing page for that module and has no down arrow icon. Only the tabs shown for each module can be arranged here. For example, if you don’t select the Tickets module, you won’t see the Tickets tabs here.

This area may not be visible unless the browser tab is full screen. If you don’t see the tab, try making your browser window larger.

7

Lookup Objects

A list of transaction objects that users of the sync profile can access in Mobile. The list is based on the modules selected above.

The objects are shown in a table with the following columns:

  • Label: The name of the lookup object. This is a read-only field that can’t be edited.

  • API Name: The API name of the lookup object. This is a read-only field that can’t be edited.

  • Rows Synced: Shows the number of records from that lookup object that are synced to Mobile based on the current sync profile settings. This number is based on the last sync and can be used for troubleshooting. If the object isn’t used, No Rows is shown

The admin can determine which:

  • fields are visible to the Mobile user for these type of objects

  • data is visible for these type of object

8

Back button

Click to return to the Sync Profile Manager main screen. If you have unsaved changes, a pop-up appears asking you to save or discard your changes.

9

Assign Users button

Click to assign users to the sync profile. This opens the Assign Users screen where you can select which users have this sync profile.

10

Save button

Click to save the changes to the sync profile. If you have unsaved changes and try to navigate away from the page, a pop-up appears asking you to save or discard your changes.

11

View Saved File

Click to view the read-only file that was generated when you last saved the sync profile. This file is used for troubleshooting and contains the sync profile’s settings, modules, transaction objects, and lookup objects.

Transaction Objects

Select one or more of the checkboxes.

Configuration Rules Summary

This table breaks down the configuration rules by module selected, what object is affected and the resulting access or condition.

Objects can’t be added to the list because they are calculated. Lookup objects can only be added by going into a transaction object and adding the lookup to a layout.
Module Object Access / Condition Notes Meaning

Job Module

Job

Read is ON

Users can view Job records; no edit unless other permissions apply.

Job Crew

All unset

Included as a child or related node under the Job object

No permissions by default; linked as a child of Job for relational queries.

Equipment Planning

All unset

Same as above; part of Job’s data graph for hierarchy.

Job Resource

All unset

Included under Job for dependency tracking; no direct access unless configured.

Price Book

Added only if Create is ON for Job

Price Book object appears only when Job creation is allowed.

Ticket Module

Ticket

Read is ON

Users can view Ticket records; no edit unless other permissions apply.

Ticket Item

Read is ON

Included as a child or related node under the Ticket object

Ticket Item is readable and treated as a child node of Ticket in the data graph.

Price Book

Read access if Ticket Item Create is ON

Not editable

Price Book becomes visible (read-only) when Ticket Item creation is enabled.

Price Book Item

Added when Ticket Item Create or Edit is ON, or when Price Book Item is an editable field on a transaction object layout. Segmentation can be enabled. See Enable Price Book Segmentation

Lookup relationship added for referencing Price Book Items.

Quote

All unset

No permissions by default; requires explicit configuration.

Quote Item

All unset

Included as a child or related node under the Quote object

Linked under Quote for hierarchy; no default access.

Standard Predicates

As an admin, add these predicates to the sync profile:

Object Predicate

Job

Tracking Number and Sync ID cannot be null

Ticket

Ticket Item

Sync ID cannot be null

Eforms & Children

Automatically Added Objects (Non-Configurable)

These are automatically added and not configured by the user:

Object Condition / Predicate

RecordType

Always added

FX5__Price_Book_Rule__c

Lookup added if Price Book Items are added

 
"FX5__Price_Book_Rule__c": {
        "predicates": [
          "FX5__IsActive__c = true"
        ]
      },

FX5__Price_Book_Rule_Action__c

Lookup added if Price Book Items are added

 
"FX5__Price_Book_Rule_Action__c": {
        "predicates": [
          "FX5__IsActive__c = true",
          "FX5__Price_Book_Rule__r.FX5__IsActive__c = true"
        ]
      },

Transaction Object Config

The Transaction Object Config section allows administrators to configure settings for each transaction object within a sync profile. This includes assigning layouts to record types and applying filters to control which records are synced.

Example 1. Ticket Item Configuration Modal - Ticket Item

This modal allows administrators to configure settings specific to the Ticket Item transaction object, including assigning layouts and applying filters and may not appear the same for other transaction objects.

Ticket Item Configuration Modal Callouts
Table 2. Transaction Object Configuration Modal - Ticket Item callouts
Callout Name Description

1

Download Filter

This area allows you to download or enter the SOQL filter for to apply to the transaction object.

2

Test Filter

This button allows you to test the current filter applied to the transaction object.

3

Check

If a check appears, the filter contains less than 200,000 records.

4

Last Filter Tested

Shows the last filter tested.

5

Selected Search Layouts

Shows the name and record type of the search layouts. If none are selected, this area will be empty with a drop-down to select layouts.

6

Assign Layouts to Record Types

This button allows you to assign layouts to the record types of the transaction object if available.

Apply Filter for a Transaction Object

Some Transaction objects don’t have layouts but a filter can be created for records shown in the List and Table views.

Administrators must understand SOQL syntax when creating filters. FieldFX validates filters when the sync profile is saved and displays errors for malformed queries. Any validation errors must be resolved before the profile can be saved.

  1. Click on the transaction object name.

  2. At the Transaction Object Config - <Transaction Object Name>, enter a valid SOQL filter.

  3. Click Apply.

The filter only applies to records in that transaction object for that sync profile.

Check the Effect of a Filter

When you change an object’s SOQL filter, its Rows Synced count updates to show how many records the new filter returns. To keep device sync efficient, adjust the filter until the object is within [200,000] records.

To see the filter that will actually run, hover over the filter icon or the Rows Synced value. The tooltip shows your filter plus the default filters FieldFX adds. If the filter has an error, the tooltip shows the error instead.

Assign Layouts to Record Types

Each active record type on a transaction object is assigned a layout. The Master record type is always assigned a layout, because FieldFX Mobile uses it to display the grid when no record type is selected.

To assign layouts to record types

  1. In the Sync Profile, open the transaction object.

  2. In the Transaction Object Config window, click Assign Layout to Record Type.

    Assign Layout to Record Type button

    The Assign Layout to Record Type window lists one row for each active record type, including Master.

    Assign Layout to Record Type window

    Record types without an assigned layout default to the Default (Master) layout.

  3. For each record type you want to change, select a layout from the list.

  4. Click Apply to apply the layout changes.

  5. Click Save updates the Transaction Object Config with the new layout assignments.

    The assignments appear in the Transaction Object Config window.

  6. Save the Sync Profile.

  • You can assign any available layout to any record type, including Master.

  • Master must always have a layout. You can’t save while Master has no layout selected.

  • Only active record types are listed. If an object has no record types, only Master appears.

  • The Assign Layout to Record Type button is always available.

Automatic layout assignment

FieldFX assigns layouts to record types automatically in these cases:

  • When an object becomes syncable. If you add a module or enable Edit access on a transaction object, every active record type on that object is assigned to the Default layout.

  • When you edit an existing Sync Profile. Any record type without a layout is assigned to the Default layout. Layouts you’ve already assigned stay the same.

If you turn off Edit access for a transaction object and then turn it back on, all record type assignments for that object reset to the Default layout. Check and reassign layouts after you change Edit access.

Apply and Save Changes

Click Apply when done making changes.

Click Save button to save changes to the sync profile.

See Validation When Editing a Sync Profile.

Once the sync profile is saved, the FieldFX_StagedDataPermissionSet permission set is updated.

Lookup Objects

See Lookup Objects.

Enable Price Book Segmentation

For sync profiles with large Price Book Item data sets, enable Price Book segmentation to stage Price Book Items separately for each Price Book. During synchronization, FieldFX retrieves the staged files for the Price Books available to the user instead of retrieving one large Price Book Item file for the entire profile.

Table 3. Segmentation Limits
Without Segmentation With Segmentation Enabled

200,000 Price Book Items across the profile

200,000 Price Book Items per Price Book

Enabling segmentation can generate multiple Price Book Item staged-data files for each segmented sync profile. Leaving the option enabled is supported, but profiles with many Price Books can generate a large number of staged-data files.
Before you begin

Price Book Item appears under Lookups only when one of these is true:

  • Ticket Item has Create or Edit access under Transaction Objects.

  • Price Book Item is an editable field on a transaction object’s layout.

To enable Price Book segmentation:

  1. Open Sync Profile Manager.

  2. Edit the applicable sync profile.

  3. Under Modules, enable Ticket.

  4. Expand Transaction Objects.

  5. For Ticket Item, select Edit or Create.

  6. Under Segmentation, select Enable.

  7. Expand Lookup Objects.

  8. Open Price Book Item.

  9. Under Segmentation, select Enable.

  10. Click Apply.

  11. Click Save.

To turn off Price Book segmentation, follow the same steps as enabling it but deselect Enable under Segmentation for the Price Book Item lookup object.

To verify the configuration:

  1. Generate or refresh staged data for the sync profile.

  2. In FieldFX Back Office, open Staged Data.

  3. Filter the records by the updated sync profile.

  4. Confirm that separate Price Book Item staged-data files exist for the profile’s Price Books.

Apply Filter for a Lookup Object

Some Lookup objects don’t have layouts but a filter can be created for records shown in the List and Table views.

Make sure you have an understanding of SOQL and constructing SOQL statements.

  1. Click on the lookup object name.

  2. At the Lookup Object Config - <Lookup Object Name>, enter a valid SOQL filter.

  3. Click Apply.

The filter only applies to records in that lookup object for that sync profile.

Select Layout

In the Lookup Config - <object name>, use the Selected Layout to choose a layout from the dropdown list.

Save Changes

Click Save button to save changes to the sync profile.

Once the sync profile is saved, the FieldFX_StagedDataPermissionSet permission set is updated.

Step-by-Step Guides

  1. Open the sync profile you want to edit.

  2. Edit the following as needed:

    • Modules the sync profile should access

    • Transaction objects

      If there is red text in the Rows Synced column, it means there is an issue with the sync for that object. Check the error message for details on the issue by hovering over the text to see the details.

    • Module Tabs

    • Lookup objects

      If there is red text in the Rows Synced column, it means there is an issue with the sync for that object. Check the error message for details on the issue by hovering over the text to see the details.

  3. Click Assign Users button to assign users to the sync profile. See Assign Users to Sync Profile for instructions.

  4. Click Save button to save changes to the sync profile.

Validation when Sync Profile Changes Are Made

When you click Save, FieldFX checks every Transaction Object and Lookup Object in the profile:

  • Errors block the save. If any object has an invalid filter or query, the profile isn’t saved. A message lists the objects with errors:

    Error message in Saving a Sync Profile

    Fix each one, then save again.

  • Warnings don’t block the save. If any object will sync more than [200,000] records, a warning appears:

    Warning message when object will sync more than 200

    The profile still saves. Consider tightening the object’s filter to cut the number of records synced to devices.

Remove a Field from a Sync Profile

To fully remove a field from a sync profile so that it no longer appears on Mobile:

  1. In Back Office, navigate to the sync profile’s page layout for the relevant object (e.g., Ticket Item).

  2. Delete or remove the field from the layout.

  3. Save the layout.

  4. Verify the field no longer appears in the page layout editor.

  5. Open every affected layout on the sync profile in the Sync Profile Manager.

  6. Re-save the profile to regenerate the static resource (description) file.

  7. Wait for the next Mobile sync cycle, then confirm the field no longer appears on the Mobile page layout.

Do not skip steps 5–6. The scheduled Stage Data Apex job does not detect field deletions. If you skip the manual re-save, the deleted field will continue to appear on Mobile indefinitely.

Troubleshooting

If you make changes to the sync profile and don’t see the expected results in Mobile, check the following:

General

Question What to Check

Did you click the Save button after making changes to the sync profile?

Changes aren’t applied until you click Save.

If you made changes to the Transaction Objects or Lookup Objects, did you click the Apply button in those sections before clicking Save?

Changes to the objects aren’t applied until you click Apply and then Save.

INVALID_FIELD – No such column 'AltSync__c' on entity 'User'

When generating staged data or validating a sync profile, the following error occurs when hovering over the INVALID_FIELD text in the Rows Synced column for a lookup object:

SELECT count() FROM User WHERE (AltSync__c=true)

ERROR: No such column 'AltSync__c' on entity 'User'

This error occurs when a sync profile references the AltSync__c field in a filter for an object that does not contain that field.

To resolve this issue, remove the reference to the AltSync__c field from the filter for that object in the sync profile. Then click Apply and Save to save the changes to the sync profile.

MALFORMED_QUERY – Invalid SOSL query

This error occurs when a sync profile filter uses a non-ID field in a query context that requires an ID field.

To resolve it, update the filter so that relationship or subquery conditions use valid ID fields, or simplify the filter to remove unsupported query logic.