FieldServiceSettings

Represents an organization’s Field Service settings.

To learn more about Field Service settings, see Enable Field Service in Salesforce Help.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for more details.

This type extends Metadata and inherits its fields.

Introduced in API version 40.0.

FieldServiceSettings components are stored in the settings directory. Files use the .settings file extension.

• Type: boolean
• Required: No

• Type: int
• Required: No
• Introduced: API version 50.0
• Description: The expiration time of apptAssistantInfoUrl after which the customer stops seeing the mobile worker’s location and estimated time of arrival.

• Type: string
• Required: No
• Introduced: API version 50.0
• Description: The tracking URL that helps a customer see the mobile worker’s estimated time of arrival and tracking information.

• Type: ApptAssistantRadiusUnit (enumeration of type string)

• Required: No

• Description: The units for specifying the geofence radius. When the mobile worker enters this area, a Last Mile notification is automatically sent. Valid values are:

  • Kilometer
  • Meter
  • Mile
  • Yard

  Available in API version 50.0 and later.

• Type: int
• Required: No
• Introduced: API version 50.0
• Description: The geofence radius from the service appointment’s address used for sending a notification to the customer when the mobile worker approaches the address.

• Type: string
• Required: No
• Introduced: API version 50.0
• Description: The status on the service appointment used to trigger En Route notification. The value has to match one of the service appointment’s Status field options. When the mobile worker selects this status on a service appointment, the customer receives the En Route notification with tracking details.

• Type: string
• Required: No
• Introduced: API version 65.0
• Description: The default status value when a service appointment is canceled.

• Type: string
• Required: No
• Introduced: API version 65.0
• Description: The default status value when a service appointment can’t be completed.

• Type: boolean
• Required: No
• Introduced: API version 57.0
• Description: Allows desktop and mobile to send geolocation and map data to Google and Apple.

• Type: boolean
• Required: No
• Introduced: API version 57.0
• Description: Allows Salesforce to send crash reports to Microsoft App Center.

• Type: boolean
• Required: No
• Introduced: API version 57.0
• Description: Allows third parties to store mobile analytics.

• Type: string
• Required: No
• Introduced: API version 65.0
• Description: The default status value when a service appointment is completed.

• Type: string
• Required: No
• Introduced: API version 54.0
• Description: Provides a public security key for users accessing a deep link action in the Field Service mobile app. Hide the redirection warning by configuring the deep link URL with a security key. The deep link URL then processes the security check.

• Type: string
• Required: No
• Introduced: API version 65.0
• Description: The default status value when a service appointment is dispatched.

• Type: boolean

• Required: No

• Description: Lets service crew members edit their service appointments.

  This setting applies only if doesShareSaWithAr is selected. For assigned resources of type Crew, crew members get Read-Write access to their service appointment and, if doesShareSaParentWoWithAr is selected, to their service appointments’ parent work orders.

• Type: boolean
• Required: No

• Type: boolean
• Required: No

• Type: boolean

• Required: No

• Description: Shares service appointments’ parent work orders with their assigned resources.

  This setting applies only if doesShareSaWithAr is selected and sharing access for work orders is set to Private or Public Read Only. Technician assigned resources get Read-Write access to their work orders. For assigned resources of type Crew, the crew leader gets Read-Write access and crew members get Read access. If the service appointment’s parent is a work order line item, assigned resources get access to the associated work order.

• Type: boolean

• Required: No

• Description: Shares dispatched service appointments with their assigned resources.

  This setting applies only if sharing access for service appointments is set to Private or Public Read Only. Technician assigned resources get Read-Write access to their service appointments. For assigned resources of type Crew, the crew leader gets Read-Write access and crew members get Read access.

• Type: boolean
• Required: No

• Type: boolean
• Required: No

• Type: boolean
• Required: No

• Type: boolean
• Required: No
• Description: Enables access to Document Builder feature.

• Type: boolean
• Required: No

• Type: boolean

• Required: No

• Description: Enables floating work orders for the org.

  Allows users to create work orders with a floating recurrence cadence based on the previous work order’s completion.

• Type: boolean
• Required: No

• Type: boolean
• Required: No
• Description: Enables Lightning SDK in the Field Service mobile app.

• Type: boolean
• Required: No
• Description: Allows the address to be populated when work orders are generated from a maintenance plan.

• Type: boolean
• Required: No

• Type: boolean
• Required: No
• Description: Turns on standby mode in the Field Service mobile app. When enabled, it helps mobile workers conserve battery and reduce distractions by pausing notifications and disabling data syncs when not actively working.

• Type: boolean

• Required: No

• Description: Enables Work Orders for the org.

  This setting allows users to use the Work Order object, whether or not Field Service is enabled. When Field Service is enabled, you can’t turn off Work Orders.

• Type: boolean
• Required: No
• Introduced: API version 52.0
• Description: Allows work plans and their work steps to be generated automatically when a work order or a work order line item is newly created. The specific work plans and work steps to be generated depends on matching criteria specified in Work Plan Selection Rules.

• Type: boolean
• Required: No
• Description: Allows a work step status to be updated manually. A prompt suggests a status update that users can accept or defer.

• Type: boolean
• Required: No

• Type: string
• Required: No

• Type: boolean

• Required: No

• Description: Turns on in-app notifications for the Salesforce mobile app and Lightning Experience users. Notifications are sent when any of the following actions occurs on a work order or work order line item that they own or follow:

  • A text or file post is added
  • A tracked field is updated
  • The record owner changes
  • The resource assignments change on a related service appointment

  If the option to track all related objects is selected in the feed tracking settings for work orders, users are also notified when child records of work orders—such as service appointments—are created or deleted.

• Type: boolean
• Required: No
• Description: Indicates whether Field Service is enabled.

• Type: string
• Required: No
• Introduced: API version 65.0
• Description: The default status value when a service appointment is in progress.

• Type: boolean
• Required: No
• Description: Syncs the location of a Service Resource to an Inventory object.

• Type: boolean
• Required: No
• Description: Tracks the location history of a Service Resource.

• Type: string
• Required: No
• Introduced: API version 54.0
• Description: Stores an email address to which a feedback email is sent when users leave feedback from the Field Service mobile app.

• Type: string
• Required: No
• Introduced: API version 65.0
• Description: The default status value when a service appointment has no specific status.

• Type: boolean
• Required: No
• Introduced: API version 55.0
• Description: Enables Field Service Enhanced Scheduling and Optimization. The default value is false.

• Type: ObjectMappingItem[]
• Required: No
• Introduced: API version 52.0
• Description: Represents an organization’s custom field mapping for Work Plan or Work Step generation. Custom Fields can be mapped from WorkPlanTemplate to WorkPlan, WorkStepTemplate to WorkStep, or WorkPlanTemplateEntry to WorkStep.

• Type: boolean
• Required: No
• Description: Allows the optimization service to access data in your Salesforce org.

• Type: boolean
• Required: No
• Description: Allows the Field Service mobile app to override the default Lightning Web Component (LWC) styling with custom or branded styles. When enabled, it applies custom styling configurations (such as brand colors, themes, and visual elements) to LWCs within the mobile application.

• Type: string
• Required: No
• Introduced: API version 65.0
• Description: The default status value when a service appointment is scheduled.

• Type: int
• Required: No
• Description: Indicates the number of days past the Created Date that the Due Date on auto-created service appointments should fall. Work types include an option to automatically add a service appointment to new work orders or work order line items using the work type.

• Type: boolean
• Required: No

• Type: boolean
• Required: No

• Type: boolean
• Required: No

• Type: WorkOrderDurationSource (enumeration of type string)

• Required: No

• Description: The source for the work order duration value. Possible values are:

  • WorkType
  • TotalFromWorkPlan
  • Custom

  Available in API version 55.0 and later.

• Type: string[]
• Required: No
• Description: The work order line item fields that the search engine should scan to suggest knowledge articles on work order line items.

• Type: string[]
• Required: No
• Description: The work order fields that the search engine should scan to suggest knowledge articles on work orders.

Represents a map of fields in the input object to fields in the output object.

• Type: string (enumeration of type string)
• Required: Yes
• Description: Required. The name of the object type containing the source fields for mapping.
• Possible values:
  • WorkPlanTemplate
  • WorkStepTemplate
  • WorkPlanTemplateEntry

• Type: ObjectMappingField[]
• Required: No
• Description: Required. The mapping of source object fields to target object fields.

• Type: string (enumeration of type string)
• Required: Yes
• Description: Required. The name of the object type that receives data from the source fields.
• Possible values:
  • WorkPlan
  • WorkStep

A field name in the input object and the corresponding field name in the output object.

• Type: string
• Required: Yes
• Description: Required. The name of a custom field supplying source data. This field is from the object specified in inputObject.

• Type: string
• Required: Yes
• Description: Required. The name of a custom field that receives data from the source field specified in inputField. This field is from the object specified in outputObject.

Represents an organization’s custom field mapping for Work Plan or Work Step generation. Custom Fields can be mapped from WorkPlanTemplate to WorkPlan, WorkStepTemplate to WorkStep, or WorkPlanTemplateEntry to WorkStep.

Introduced in API version 52.0.

• Type: MappingType (enumeration of type string)
• Required: Yes
• Description: The type of object mapping.
• Possible values:
  • WorkPlans_WorkPlanTemplate_WorkPlan — Maps a WorkPlanTemplate to a WorkPlan
  • WorkPlans_WorkStepTemplate_WorkStep — Maps a WorkStepTemplate to a WorkStep
  • WorkPlans_WorkPlanTemplateEntry_WorkStep — Maps a WorkPlanTemplateEntry to a WorkStep

• Type: ObjectMapping
• Required: Yes
• Description: The object mapping details.

This sample file shows a subset of the possible field service settings that you can customize.

1<?xml version="1.0" encoding="UTF-8"?>
2<FieldServiceSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3   <doesAllowEditSaForCrew>false</doesAllowEditSaForCrew>
4   <doesShareSaParentWoWithAr>false</doesShareSaParentWoWithAr>
5   <doesShareSaWithAr>false</doesShareSaWithAr>
6   <enableWorkOrders>false</enableWorkOrders>
7   <enableWorkPlansAutoGeneration>true</enableWorkPlansAutoGeneration>
8   <fieldServiceNotificationsOrgPref>false</fieldServiceNotificationsOrgPref>
9   <fieldServiceOrgPref>true</fieldServiceOrgPref>
10   <isGeoCodeSyncEnabled>false</isGeoCodeSyncEnabled>
11   <isLocationHistoryEnabled>false</isLocationHistoryEnabled>
12   <o2EngineEnabled>false</o2EngineEnabled>
13   <objectMappingItem>
14      <mappingType>WorkPlans_WorkPlanTemplate_WorkPlan</mappingType>
15      <objectMapping>
16         <inputObject>WorkPlanTemplate</inputObject>
17         <mappingFields>
18            <inputField>WorkPlanTemplate_CustomNumberField__c</inputField>
19            <outputField>WorkPlan_CustomNumberField__c</outputField>
20         </mappingFields>
21         <mappingFields>
22            <inputField>WorkPlanTemplate_CustomTextField__c</inputField>
23            <outputField>WorkPlan_CustomPicklistField__c</outputField>
24         </mappingFields>
25         <outputObject>WorkPlan</outputObject>
26      </objectMapping>
27   </objectMappingItem>
28   <objectMappingItem>
29      <mappingType>WorkPlans_WorkStepTemplate_WorkStep</mappingType>
30      <objectMapping>
31         <inputObject>WorkStepTemplate</inputObject>
32         <mappingFields>
33            <inputField>WokStepTemplate_CustomNumberField__c</inputField>
34            <outputField>WokStep_CustomNumberField__c</outputField>
35         </mappingFields>
36         <mappingFields>
37            <inputField>WokStepTemplate_CustomTextField__c</inputField>
38            <outputField>WokStep_CustomTextField__c</outputField>
39         </mappingFields>
40         <outputObject>WorkStep</outputObject>
41      </objectMapping>
42   </objectMappingItem>
43   <objectMappingItem>
44      <mappingType>WorkPlans_WorkPlanTemplateEntry_WorkStep</mappingType>
45      <objectMapping>
46         <inputObject>WorkPlanTemplateEntry</inputObject>
47         <mappingFields>
48            <inputField>WorkPlanTemplateEntry_CustomDateField__c</inputField>
49            <outputField>WokStep_CustomDateField__c</outputField>
50         </mappingFields>
51         <outputObject>WorkStep</outputObject>
52      </objectMapping>
53   </objectMappingItem>
54   <optimizationServiceAccess>false</optimizationServiceAccess>
55   <serviceAppointmentsDueDateOffsetOrgValue>7</serviceAppointmentsDueDateOffsetOrgValue>
56   <workOrderLineItemSearchFields>Subject</workOrderLineItemSearchFields>
57   <workOrderSearchFields>Subject</workOrderSearchFields>
58</FieldServiceSettings>

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.