FieldServiceMobileSettings

Represents a configuration of settings that control the Field Service iOS and Android mobile app experience. This object is available in API version 38.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert()

Special Access Rules

Field Service must be enabled.

Fields

Field Name	Details
BgGeoLocationAccuracy	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The accuracy of geolocation tracking of services resources while the app is running in the background. Lowering accuracy reduces battery consumption for mobile devices. Available in API version 41.0 and later. Picklist options: `Medium`—Accurate to within about 100 meters. `Coarse`—Accurate to within about 1 kilometer. `Very Coarse`—Accurate to within about 3 kilometers. The default value is `Coarse`.
BgGeoLocationMinUpdateFreqMins	Type int Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The frequency of geolocation poling of services resources while the app is running in the background. Less frequent poling decreases battery consumption for mobile devices. The label in the UI is Minimum Update Frequency of Geo Location in Minutes (Background). Available in API version 41.0 and later.
BrandInvertedColor	Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The color of toasts and the contrast color of the floating action button.
ContrastInvertedColor	Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The color of secondary backgrounds in the UI.
ContrastPrimaryColor	Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The color of primary text.
ContrastQuaternaryColor	Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The color of secondary lines that delineate different areas of the UI.
ContrastQuinaryColor	Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The color of primary backgrounds in the UI.
ContrastSecondaryColor	Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The color of secondary text.
ContrastTertiaryColor	Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The color of the icons on the settings screen and of primary lines that delineate different areas of the UI.
DefaultListViewDeveloperName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The API name of the default service appointment list view on the schedule screen.
DeveloperName	Type string Properties Create, Filter, Group, Sort, Update Description The API name of the set of field service mobile settings. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. Note
FeedbackPrimaryColor	Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The color of error messages.
FeedbackSecondaryColor	Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The color of success messages.
FeedbackSelectedColor	Type string Properties Create, Defaulted on create, Group, Sort, Update Description The color indicating the user’s current selection.
FutureDaysInDatePicker	Type int Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The number of days into the future that a user can select from the date picker on the schedule screen.
GeoLocationAccuracy	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The accuracy of service resource geolocation tracking. Lowering accuracy reduces battery consumption for mobile devices. Picklist values: `Fine`—Accurate to within 10 meters. `Medium`—Accurate to within 100 meters. `Coarse`—Accurate to within 1 kilometer. The default value is `Medium`.
GeoLocationMinUpdateFreqMins	Type int Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The minimum number of minutes between attempts to poll geolocation.
IsAssignmentNotification	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Controls whether service appointment notifications are sent when the service resource is assigned the appointment. Default is `false`. This field is available in API version 46.0 and later.
IsDefault	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates that the set of field service mobile settings is the default set that is automatically assigned to users. You can’t make a different settings record the default, but you can modify the default settings record. Default is `false`. Available in API version 41.0 and later.
IsDispatchNotification	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Controls whether service appointment notifications are sent when the service resource is dispatched for the appointment. Default is `false`. This field is available in API version 46.0 and later.
IsSendLocationHistory	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Controls whether geolocation tracking of services resources is enabled. Default is `false`.
IsShowEditFullRecord	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Controls whether users can edit records with the field service mobile app. Default is `false`.
IsTimeSheetEnabled	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Controls whether users can access time sheets on their mobile devices (Beta). Default is `false`.
IsTimeZoneEnabled	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Controls whether the time zone of timesheet entries on the mobile app is recorded. The current time zone is recorded in the LocationTimeZone field of the TimeSheetEntry object. Default is `false`. Available in API version 50.0 and later.
IsUseSalesforceMobileActions	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Reserved for future use.
Language	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The localization preference for a user. The format is a two letter language code and, if there’s a dialect, followed by the two letter dialect, for example, `fr` for French, and `fr_BE` for Belgian French
MasterLabel	Type string Properties Create, Filter, Group, Sort, Update Description The label in the UI for the set of field service mobile settings. Available in API version 41.0 and later.
MetadataCacheTimeDays	Type int Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The number of days that org metadata, such as layouts, is kept in the app’s local cache of memory.
NavbarBackgroundColor	Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The color of the top bar in the app.
NavbarInvertedColor	Type string Properties Create, Defaulted on create, Group, Sort, Update Description The secondary color of the tap bar in the app.
PastDaysInDatePicker	Type int Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The number of days into the past that a user can select from the date picker on the schedule screen.
PrimaryBrandColor	Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The main branding color used throughout the UI.
QuickStatusChangeFlowName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of an existing Field Service flow with a Quick Status Change action to change the work order or service appointment status or both. This applies to flows invoked on the mobile app only. This field is available in API version 51.0 and later.
RecordDataCacheTimeMins	Type int Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The number of minutes that record data is kept in the app’s local cache of memory.
SecondaryBrandColor	Type string Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The color of action buttons.
TimeIntervalSetupMins	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Controls the spacing of picklist options for time values such as when creating resource absences.
UpdateScheduleTimeMins	Type int Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The minimum number of minutes between attempts to update a user’s schedule. The user’s schedule might not refresh on this cadence if the user’s device isn’t connected to a network or doesn’t have adequate battery life. Note

Usage

Field Service Mobile settings allow you to create sets of settings to apply to different field service mobile users. The settings apply to both the Android and iOS versions of the app.

For example, suppose you want to accommodate workers that are color blind, or who work in dark or bright conditions. You can choose different branding options for different workers to suit their needs, and assign them to their profiles.

Object Reference for Salesforce and Lightning Platform

FieldServiceMobileSettings

Supported Calls

Special Access Rules

Fields

Usage