FieldServiceSettings | Metadata API Developer Guide

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

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

Version

FieldServiceSettings is available in API version 40.0 and later.

Fields

Field	Field Type	Description
fieldServiceNotificationsOrgPref	boolean	Turns on in-app notifications for the Salesforce app and Lightning Experience users 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.
fieldServiceOrgPref	boolean	Indicates whether Field Service Lightning is enabled.
serviceAppointmentsDueDateOffsetOrgValue	int	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.
workOrderLineItemSearchFields	string	The work order line item fields that the search engine should scan to suggest knowledge articles on work order line items.
workOrderSearchFields	string	The work order fields that the search engine should scan to suggest knowledge articles on work orders.

Declarative Metadata Sample Definition

This is a sample field service settings file.

1<?xml version="1.0" encoding="UTF-8"?>
2<FieldServiceSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <fieldServiceNotificationsOrgPref>false</fieldServiceNotificationsOrgPref>
4    <fieldServiceOrgPref>true</fieldServiceOrgPref>
5    <serviceAppointmentsDueDateOffsetOrgValue>6</serviceAppointmentsDueDateOffsetOrgValue>
6    <workOrderSearchFields>WorkOrderNumber</workOrderSearchFields>
7    <workOrderSearchFields>Status</workOrderSearchFields>
8    <workOrderSearchFields>Address</workOrderSearchFields>
9    <workOrderSearchFields>Subject</workOrderSearchFields>
10    <workOrderLineItemSearchFields>Subject</workOrderLineItemSearchFields>
11</FieldServiceSettings>