FieldServiceMobileSettings
Represents a configuration of settings that control the Field Service iOS and Android mobile app experience.
Introduced in API version 39.0.
create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert()
- Field Service must be enabled.
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Introduced: API version 52.0
- Description: Describes how status changes are handled.
- Possible values:
- Off — Off — No automatic status changes.
- Manual — Manual — The mobile worker can cancel or update the status change.
- Timed — Timed — The mobile worker has a time period to prevent the status change. When the timer ends, the status changes.
- Automated — Automated — The mobile worker is notified that the status has changed.
-
Type: int
-
Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
-
Introduced: API version 52.0
-
Default value: 60
- Type: picklist
- Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 52.0
- Type: picklist
- Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 52.0
- Description: Status that indicates that a mobile worker is at a service appointment.
- Possible values:
- Canceled — Canceled
- Cannot Complete — Cannot Complete
- Completed — Completed
- Dispatched — Dispatched
- In Progress — In Progress
- None — None
- Scheduled — Scheduled
- Type: int
- Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 52.0
- Description: Service appointment radius that can trigger a status change.
- Default value: 150
- Type: int
- Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 52.0
- Description: A time period when status changes can occur, before an appointment’s scheduled start time and after the scheduled end time. The time is applied only if IsAscTimeLimitEnabled is
true. - Default value: 15
- Type: picklist
- Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 52.0
- Description: Status that indicates that a mobile worker is traveling to a service appointment.
- Possible values:
- Canceled — Canceled
- Cannot Complete — Cannot Complete
- Completed — Completed
- Dispatched — Dispatched
- In Progress — In Progress
- None — None
- Scheduled — Scheduled
-
Type: picklist
-
Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
-
Introduced: API version 41.0
-
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. Picklist options:
The default value is
Coarse. -
Possible values:
- Medium — Medium — Accurate to within about 100 meters.
- Coarse — Coarse (default) — Accurate to within about 1 kilometer.
- Very Coarse — Very Coarse — Accurate to within about 3 kilometers.
-
Default value: Coarse
- Type: int
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Introduced: API version 41.0
- 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).
- Default value: 60
- 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.
- Type: string
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Description: The color of secondary backgrounds in the UI.
- Type: string
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Description: The color of primary text.
- Type: string
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Description: The color of secondary lines that delineate different areas of the UI.
- Type: string
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Description: The color of primary backgrounds in the UI.
- Type: string
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Description: The color of secondary text.
- 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.
-
Type: int
-
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
-
Introduced: API version 59.0
-
Default value: 2
- Type: int
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Introduced: API version 59.0
- Description: Days before the current service date during which to prime service documents for offline use.
- Default value: 2
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The API name of the default service appointment list view on the schedule screen.
- Type: picklist
- Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Introduced: API version 61.0
-
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.
- Type: string
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Description: The color of error messages.
- Type: string
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Description: The color of success messages.
- Type: string
- Properties: Create, Defaulted on create, Group, Sort, Update
- Introduced: API version 40.0
- Description: The color indicating the user’s current selection.
- Type: string
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Introduced: API version 65.0
- Type: int
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Introduced: API version 40.0
- Description: The number of days into the future that a user can select from the date picker on the schedule screen.
- Default value: 45
-
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:
The default value is
Medium. -
Possible values:
- Fine — Fine — Accurate to within 10 meters.
- Medium — Medium (default) — Accurate to within 100 meters.
- Coarse — Coarse — Accurate to within 1 kilometer.
-
Default value: Medium
- Type: int
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Description: The minimum number of minutes between attempts to poll geolocation.
- Default value: 10
- Type: boolean
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Introduced: API version 58.0
- Description: Indicates whether AscTimeLimitationInMin is applied. Default is
true
- Type: boolean
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Introduced: API version 46.0
- Description: Controls whether service appointment notifications are sent when the service resource is assigned the appointment. Default is
false. - Default value: false
- Type: boolean
- Properties: Defaulted on create, Filter, Group, Sort
- Introduced: API version 41.0
- 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. - Default value: false
- Type: boolean
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Introduced: API version 46.0
- Description: Controls whether service appointment notifications are sent when the service resource is dispatched for the appointment. Default is
false.
-
Type: boolean
-
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
-
Introduced: API version 66.0
-
Default value: false
-
Type: boolean
-
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
-
Introduced: API version 66.0
-
Default value: false
-
Type: boolean
-
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
-
Introduced: API version 57.0
-
Default value: false
-
Type: boolean
-
Properties: Defaulted on create, Filter, Group, Sort
-
Introduced: API version 58.0
-
Default value: false
- Type: boolean
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Introduced: API version 55.0
- Description: Determines whether resource absences appear in the Schedule tab of the mobile app.
- Default value: false
- Type: boolean
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Description: Controls whether geolocation tracking of services resources is enabled. Default is
false. - Default value: false
- 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. - Default value: false
- Type: boolean
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Introduced: API version 47.0
- Description: Controls whether users can access time sheets on their mobile devices (Beta). Default is
false.
- Type: boolean
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Introduced: API version 50.0
- Description: Controls whether the time zone of timesheet entries on the mobile app is recorded. The current time zone is recorded in the
LocationTimeZonefield of the TimeSheetEntry object. Default isfalse. - Default value: false
- Type: boolean
- Properties: Defaulted on create, Filter, Group, Sort
- Introduced: API version 43.0
- Description: Reserved for future use.
- Default value: false
-
Type: boolean
-
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
-
Introduced: API version 64.0
-
Default value: false
- 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,
frfor French, andfr_BEfor Belgian French
- Type: string
- Properties: Create, Filter, Group, Sort, Update
- Introduced: API version 41.0
- Description: The label in the UI for the set of field service mobile settings.
- Type: int
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Introduced: API version 59.0
- Description: Sets the maximum number of service appointments to use for offline priming of service documents. If you don’t have dates on your service appointments, this setting helps to optimize offline priming in place of
DaysBeforeCurrentServiceDateandDaysBeforeCurrentServiceDatefields. - Default value: 50
- 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.
- Default value: 7
- Type: string
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Description: The color of the top bar in the app.
- Type: string
- Properties: Create, Defaulted on create, Group, Sort, Update
- Introduced: API version 40.0
- Description: The secondary color of the tap bar in the app.
- Type: string
- Properties: Filter, Group, Nillable, Sort
- Introduced: API version 58.0
- Type: int
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Introduced: API version 40.0
- Description: The number of days into the past that a user can select from the date picker on the schedule screen.
- Default value: 45
- Type: string
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Description: The main branding color used throughout the UI.
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 51.0
- 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.
- 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.
- Default value: 240
- Type: string
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Description: The color of action buttons.
-
Type: reference
-
Properties: Create, Filter, Group, Nillable, Sort, Update
-
Introduced: API version 41.0
-
Relationship name: SosDeployment
-
Relationship type: relationship
-
Refers to: SOSDeployment
- 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.
- 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.
- Default value: 30
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.
This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.
- FieldServiceMobileSettingsChangeEvent: Introduced in API version 55.0.