Newer Version Available

This content describes an older version of this product. View Latest

FieldServiceOrgSettings

Represents the org settings for Field Service, such as Appointment Assistant settings. If Field Service is enabled, the org contains one read-only record of this object. This object is available in API version 51.0 and later.

Supported Calls

describeSObjects(), query(), retrieve()

Special Access Rules

To see this object, Field Service must be enabled. For specified fields in the table, Appointment Assistant must also be enabled.

Fields

Field Details
ApptAssistantExpiration
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The expiry time in minutes of when the customer stops seeing the mobile worker’s location. Appointment Assistant must also be enabled to see this field.
ApptAssistantInfoUrl
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The page URL that enables Appointment Assistant. Appointment Assistant must also be enabled to see this field.
ApptAssistantRadiusUnit
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The unit of the radius of the service appointment that prompts the Last Mile event for Appointment Assistant. Appointment Assistant must also be enabled to see this field.
Possible values are:
  • Kilometer
  • Meter
  • Mile
  • Yard
ApptAssistantRadiusValue
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The radius of the service appointment that prompts the Last Mile event for Appointment Assistant. Appointment Assistant must also be enabled to see this field.
ApptAssistantStatus
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Sort
Description
The value that prompts the En Route event for Appointment Assistant. Appointment Assistant must also be enabled to see this field.
Possible values are:
  • Canceled
  • Cannot Complete
  • Completed
  • Dispatched
  • In Progress
  • None
  • Scheduled
  • TestSharing
The default value is 'None'.
CanPopulateGoogleAddress
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Allows desktop and mobile to send geolocation and map data to Google and Apple. Available in API version 57.0 and later.
The default value is true.
CanSendAppCenterCrashReports
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Allows Salesforce to send crash reports to Microsoft App Center. Available in API version 57.0 and later.
The default value is true.
CanStoreMobileAnalytics
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Allows third parties to store mobile analytics. Available in API version 57.0 and later.
The default value is true.
DeveloperName
Type
string
Properties
Filter, Group, Sort
Description
The unique name of the object in the API.

Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.

Note

DoesAvlCalcInclOvertime
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Specifies whether overtime is included in work capacity availability calculations. Available in API version 59.0 and later.
The default value is false.
DoesAvlCalcInclPrimOnly
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Specifies if primary members only are included in work capacity availability calculations. If the value is false both primary and secondary members of the service territory are included. Available in API version 59.0 and later.
The default value is false.
Language
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The language of the field service org settings.
The format for the values is a two-letter language code in small letters, for example, fr for French. If the language has regional dialects, add the two-letter country code in capital letters, for example, use fr_BE for Belgian French.
MasterLabel
Type
string
Properties
Filter, Group, Sort
Description
The label of the field service org settings.