SyncLink Records

SyncLink records associate a FieldFX Mobile user with a record that is available for synchronization.

A SyncLink can associate a user with one of the following record types:

  • Job

  • Work Order

  • Quote - Quote SyncLinks also include the Price Book when present

  • Price Book - Generated Job SyncLinks include the associated Price Book when present

Each SyncLink record contains a User lookup and one entity lookup. Only one entity lookup is populated on a SyncLink record.

These are the permissions required for a user to see and sync records through a sync profile:

Requirement Detail

Object permissions

Required for SyncLink (Create, Read, Edit, Delete, View All, Modify All, if applicable) and for the object being linked.

Field-level permissions

Required for all fields on the linked layout, including fields in Details, Tile, Table, and Hidden sections. Missing field-level permissions can leave a linked profile incomplete or cause records not to sync even when included.

Permission set assignment

Used to grant SyncLink access and whether access is delivered through a permission set, permission-set group, profile, or another mechanism.

Related list view access

Including the permissions needed for a user to view the SyncLink related list on a parent record.

Manual record management requirements

Including the permissions needed to create or delete SyncLink records manually.

Access to the Sync Profile Manager UI does not necessarily imply access to SyncLink records. Document SyncLink security and visibility requirements independently from layout or page access.

Required Permissions

Access to SyncLink records is controlled through Salesforce object permissions. Administrators who manage SyncLink records must be granted the appropriate permissions on the SyncLink object (FX5__SyncLink__c).

Object View (Read) Create Edit Delete View All Modify All

SyncLink (FX5__SyncLink__c)

TBD

Salesforce administrator or equivalent user with access to manage Sync Link records. Manual Sync Links are maintained separately from auto-generated links.

Administrator access recommended for Sync Link administration.

Related objects referenced by the SyncLink record (Job, Work Order, Quote, Price Book, User)

TBD

N/A

N/A

N/A

Access as required by the organization’s visibility model.

FieldFX supports automatically and manually created SyncLink records.

SyncLink Type Description

Automatic

Created by FieldFX through a supported automated process, such as a Sync Configuration or Job Crew Planning. The AutoAdded__c field identifies an automatically created SyncLink.

Manual

Created to explicitly associate a user with a supported record. For example, an administrator can use a manual SyncLink to associate a Work Order with a FieldFX Mobile user.

Do not manually modify system-maintained fields, including AutoAdded__c and UID__c.

The SyncLink object uses the following fields.

Field Type Description

Name

Auto Number

The record identifier. FieldFX generates the value using the SYNC-{00000} format.

User

Lookup

The user associated with the SyncLink.

Job

Lookup

The Job associated with the user.

Work Order

Lookup

The Work Order associated with the user.

Quote

Lookup

The Quote associated with the user.

Price Book

Lookup

The Price Book associated with the user.

AutoAdded

Checkbox

Indicates whether FieldFX created the SyncLink through an automated process.

UID

Text

A system-maintained identifier used to distinguish SyncLink records.

A SyncLink contains a value for only one of the Job, Work Order, Quote, or Price Book lookups.

Step-by-Step Guides

Use the following processes:

The same procedure can be used for Work Order, Quote, and Price Book page layouts if the Sync Links related list is available for those objects.

To ensure that sync links are available for a Job, Work Order, Quote, and Price Books, the Layout object must have a SyncLinks panel on the Related tab. Follow these steps to add it:

  1. In Salesforce Setup, go to Object Manager and open the object that displays SyncLink records:

    Either:

    • Job (Managed) Object

    • Work Order

    • Quote

    • Price Book.

  2. Select Page Layouts.

  3. Open the page layout assigned to the users who need access to the related list.

  4. In the page layout editor, go to the Related selection from the palette.

  5. Drag the SyncLinks panel onto the layout.

  6. Click the wrench icon on the panel to open its properties.

  7. In the Related List Properties dialog,

    1. Set the Sort By field to User and the Sort Order to Ascending.

    2. Select Show Quick Action Buttons and click OK.

  8. Click Save to save the layout.

The SyncLinks related list displays SyncLink records associated with the Job.

SyncLinks panel on the Related tab of a Job layout

If you’re using Lightning record pages, verify the page includes the standard Related Lists component (or Dynamic Related List - Single). If it doesn’t, add the component to the page and click Save.

Example 1. Job Sync Link record

Because a Job Sync Link record contains a populated a Job__c lookup back to the Job, Salesforce can display the related list from the Job record.

Create a manual SyncLink when a Work Order must be explicitly associated with a FieldFX Mobile user.

  1. In FieldFX Back Office, open the SyncLinks tab.

  2. Click New.

  3. In User, select the FieldFX Mobile user.

  4. In Work Order, select the Work Order to associate with the user.

  5. Leave the Job, Quote, and Price Book fields blank.

  6. Click Save.

The resulting SyncLink associates the selected Work Order with the selected user.

The Work Order must otherwise be eligible for synchronization under the organization’s FieldFX Mobile configuration.

To associate a user with a Job, Quote, or Price Book:

  1. Create a SyncLink and populate:

    • The User field.

    • The lookup for the record type being associated.

  2. Leave the other entity lookups blank.

For example, for a Quote SyncLink, select a user and a Quote, and leave the Job, Work Order, and Price Book fields blank.

FieldFX can create SyncLinks automatically through supported processes such as:

  • Sync Configurations

  • Job Crew Planning

For automatically created records, FieldFX selects AutoAdded and generates the system-maintained UID.

Do not edit or delete automatically created SyncLinks as a routine assignment method. Update the configuration or source record that caused FieldFX to create the SyncLink.

FieldFX constructs the UID differently for automatic and manual SyncLinks:

  • For an automatically created SyncLink, the UID is based on the associated entity, user, and an automatic-entry indicator.

  • For a manually created SyncLink, the UID is based on the associated entity and user.

The UID supports internal record identification and should not be used as a user-entered value.

Recommended Page Layout

When configuring a SyncLink page layout for administrators, include the fields needed to identify the user and associated record:

  • Name

  • User

  • Job

  • Work Order

  • Quote

  • Price Book

Do not expose the following system-maintained fields for manual entry:

  • AutoAdded

  • UID

Troubleshooting

For assignment troubleshooting, refer to the Troubleshoot Sync Assignments documentation.

For more information, see:

FieldFX Documentation Salesforce Documentation

N/A