Sync Configuration Setup

Introduction

When setting up a Sync Configuration, consider these factors when syncing a record to a user’s device:

  • Whether user access must have access to Salesforce sharing settings to access to the record.

  • Whether the org uses the Sync V4 Config discussed on this page to control sync

    • If the org has enabled Sync V4 Config, the user must have a Sync Configuration defined, and the sync configuration must allow the record to sync.

  • If the record’s object has a workflow defined, the record must be in a syncable status.

  • If the org is using AltSync, the record’s AltSync flag must be selected.

    Decision Flowchart determining if a record syncs

Prerequisites

To manage sync configurations, you need to:

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

Step-by-Step Guides

Add a Sync Configuration

Sync configurations control the jobs that sync to FieldFX Mobile. You can add one or multiple sync configurations for a user. Sync Configurations with Sync - Job Crew Only specified automatically generate for Contact records with the Available for Field Work option selected.

Two sync configuration records generate for the contact:

  1. One configuration that enables the user to sync all jobs for which they are assigned to the job crew.

  2. One configuration that enables the user to sync all jobs for the user’s Office.

You can disable the automatic generation of either or both of these sync configuration records.

Guidelines

If you install the FX5 AltSync package, you must add a sync configuration for every FieldFX Mobile user on the following release channels:

  • Sync V4 Beta

  • Sync V4

  • V4 Quarterly Beta

  • V4 Quarterly

For more information, see Sync 4.0 Release Channels.

  1. Access FieldFX Back Office.

  2. Open the Sync Configurations tab.

  3. Click New.

  4. In Contact, select a user contact.

  5. Select the jobs to display:

    If you don’t select any of these options, the user can’t access any jobs.

    1. Select Sync – Job Crew Only to display jobs where the user is dispatched to the job.

    2. In Office, select an office to display jobs for that office.

    3. In Account, select a customer to display jobs with price books linked to that customer.

    4. In Job Type, select a job type to display jobs of that type.

    5. In Segment, select a business segment to display jobs for that segment.

  6. Click Save.

You can add more than one sync configuration record for a user, such as if the user should be able to sync records for more than one Office or Segment.

Enable the Automatic Generation of Sync Configuration Records

  • Sync Configuration records can automatically generate for a user when you create the user’s contact record and select the Available for Field Work option.

    1. All syncable jobs where the user has been assigned to the job crew.

    2. All syncable jobs for the user’s Office.

  • The automatic generation of either or both of these configuration records can be enabled as described below.

To process this:

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

  2. Click AppSetting.

  3. Under Custom Fields, click Edit next to Active.

  4. Under General Options, change the Default Value to Checked.

  5. Click Save.

  6. Follow the instructions below to enable the automatic generation of sync configuration records for a user’s job assignments, a user’s assigned office, or both.

Enable for a User’s Job Crew Assignments

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

  2. Click Manage Records next to the AppSetting row.

  3. Click Edit next to ContactSyncJobCrew.

  4. In Value, enter true.

  5. Click Save.

Enable for a User’s Office

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

  2. Click Manage Records next to the AppSetting row.

  3. Click Edit next to ContactSyncJobOffice.

  4. In Value, enter true.

  5. Click Save.

Troubleshooting Sync

When there are issues with Sync, these are the most common types and suggestions on how to resolve them:

Browser Errors

  • FieldFX Mobile users needing access to multiple fields from an object may run into browser 414 or 431 errors that result when a URL is too long to process.

  • This may happen if the FieldFX Mobile user accesses too many fields from the object, or if the API Names of the fields are too long.

  • Resolve the issue by reducing the number of fields accessed by the FieldFX Mobile user or reducing the length of the API Names for custom fields.

    The resulting URL must be less than 8,000 characters in length.

    Field names must be separated by a comma in the query which is added to a URL. Commas take 3 characters in a URL.

    Keep this in mind when figuring out the potential length of a URL.

Sync Simulator

  • Use the Sync Simulator to display an object-by-object breakdown of the data and attachments that sync to a user’s device.

  • The sync simulator must be setup prior to first use.

Sync Health Board

  • The Sync Health Board displays real-time metrics about sync performance.

  • The Sync Health Board must be setup prior to first use.

Sync Event Viewer

Use the Sync Event Viewer to troubleshoot and resolve sync upload errors.

Record Access Check

The Record Access Check tool displays what kind of access a user has to a specific record.

User Share View

Use the User Share View tool to figure out what grants a user access to a particular record.

Sync Events

  • Use the Audit Log to view sync activity across users.

  • Use the Packet Viewer to troubleshoot a particular sync for a specific user.