IndustriesSettings

Represents settings for Salesforce Scheduler.

This type extends the Metadata metadata type and inherits its fullName field.

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

File Suffix and Directory Location

IndustriesSettings are stored in a single file named Industries.settings in the settings directory.

Version

Industries settings for Salesforce Scheduler are available in API version 47.0 and later.

Fields

appointmentDistributionOrgPref

Field Type: boolean
Description: Indicates whether to schedule appointments for service resources based on appointment distribution (true) or not (false). Available in API version 52.0 and later.
Default value: false

captureResourceUtilizationOrgPref

Field Type: boolean
Description: Indicates whether to use a background process to calculate the usage of service resources from service appointments (true) or not (false). Available in API version 52.0 and later.
Default value: false

enableAnyResourceTypeOrgPref

Field Type: boolean
Description: Indicates whether to enable Salesforce Scheduler to consider service resource records with Agent resource type (true) or not (false). Before enabling this setting, create a service resource record as Main for each user, or update one of the service resource records as Main for each user. Available in API version 57.0 and later.
Default value: false

enableAppFrmAnywhereOrgPref

Field Type: boolean
Description: Indicates whether to use engagement channels for setting up shifts, work types, and booking a service appointment (true) or not (false). Available in API version 56.0 and later. See the prerequisites before you enable this setting.
Default value: false

enableBlockResourceAvailabilityOrgPref

Field Type: boolean
Description: Indicates whether Salesforce Scheduler service appointments are added to users’ Salesforce calendars. For example, if set to false, users don’t see their service appointments on their calendars. The default is false. Available in API version 47.0 and later. This setting is used in Financial Services Cloud.

enableCapacitySchedulingPref

Field Type: boolean
Description: Indicates whether users can use capacity-based scheduling (true) or not (false). Use capacity-based scheduling to control the number of appointments that can be scheduled for a given shift and type of work. Available in API version 62.0 and later. See the prerequisite before you enable this setting.

enableCreateMultiAttendeeEventOrgPref

Field Type: boolean
Description: Indicates whether users can group individual events, and view the list of all attendees under a single event true or not false. See the prerequisites before you enable this setting. Available in API version 55.0 and later. This setting is used in Financial Services Cloud.
Default value: false

enableDropInAppointmentsOrgPref

Field Type: boolean
Description: Indicates whether users can manage drop-in participants (true) or not (false). Available in API version 58.0 and later. See the prerequisite before you enable this setting.
Default value: false

enableDropInSkillMatchingOrgPref

Field Type: boolean
Description: Indicates whether skill and skill level matching is enabled for service resources that are assigned to waitlists for a service territory (true) or not (false). Available in API version 58.0 and later.
Default value: false

enableEventManagementOrgPref

Field Type: boolean
Description: Indicates whether users can add Salesforce Scheduler service appointments to their Salesforce calendars. Available in API version 47.0 and later. This setting is used in Financial Services Cloud.
Default value: false

enableEventWriteOrgPref

Field Type: boolean
Description: Indicates whether to publish high-volume platform events when users create, update, or delete service appointments in Salesforce Scheduler (true) or not (false). If enabled, write these events to an external system to update it with Salesforce Scheduler service appointments. Available in API version 49.0 and later.
Default value: false

enableMultipleTopicsForShiftsOrgPref

Field Type: boolean
Description: Indicates whether the multiple topics for shifts feature is enabled (true) or disabled (false). Available in API version 56.0 and later. See the prerequisite before you enable this setting.
Default value: false

enableMultiResourceOrgPref

Field Type: boolean
Description: Indicates whether users can add multiple service resources to a service appointment. Available in API version 47.0 and later. This setting is used in Financial Services Cloud.
Default value: false

enableOverbookingOrgPref

Field Type: boolean
Description: Indicates whether users can add multiple service appointments to a single time slot for a service resource. If set to false, concurrent time slots are visible, but can’t be modified. Available in API version 47.0 and later. This setting is used in Financial Services Cloud.
Default value: false

enableShareSaWithArOrgPref

Field Type: boolean
Description: Indicates whether to share service appointments with assigned resources (true) or not (false). Available in API version 55.0 and later.
Default value: false

enableTopicOrTemplate

Field Type: boolean
Description: Indicates whether to use Salesforce Scheduler to manage Health Cloud appointments (true) or not (false). You must enable the enableTopicTimeSlot field before enabling this setting. Available in API version 52.0 and later.
Default value: false

enableTopicTimeSlot

Field Type: boolean
Description: Indicates whether to set operating hours for Service Territory Members for Work Type Groups (true) or not (false). Available in API version 52.0 and later.

See the prerequisites before you enable this setting. After you enable this setting, you can’t disable it.
Default value: false

Declarative Metadata Sample Definition

The following is an example of an Industries.Settings metadata file.

1<?xml version="1.0" encoding="UTF-8"?>
2<IndustriesSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3   <appointmentDistributionOrgPref>true</appointmentDistributionOrgPref>
4   <captureResourceUtilizationOrgPref>true</captureResourceUtilizationOrgPref>
5   <enableBlockResourceAvailabilityOrgPref>true</enableBlockResourceAvailabilityOrgPref>
6   <enableCreateMultiAttendeeEventOrgPref>true</enableCreateMultiAttendeeEventOrgPref>
7   <enableDropInSkillMatchingOrgPref>true</enableDropInSkillMatchingOrgPref>
8   <enableEventManagementOrgPref>true</enableEventManagementOrgPref>
9   <enableAppFrmAnywhereOrgPref>true</enableAppFrmAnywhereOrgPref>
10   <enableAnyResourceTypeOrgPref>true</enableAnyResourceTypeOrgPref>
11   <enableDropInAppointmentsOrgPref>true</enableDropInAppointmentsOrgPref>
12   <enableEventWriteOrgPref>true</enableEventWriteOrgPref>
13   <enableMultipleTopicsForShiftsOrgPref>true</enableMultipleTopicsForShiftsOrgPref>
14   <enableMultiResourceOrgPref>true</enableMultiResourceOrgPref>
15   <enableOverbookingOrgPref>true</enableOverbookingOrgPref>
16   <enableShareSaWithArOrgPref>true</enableShareSaWithArOrgPref>
17   <enableTopicOrTemplate>true</enableTopicOrTemplate>
18   <enableTopicTimeSlot>true</enableTopicTimeSlot>
19</IndustriesSettings>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3   <types>
4       <members>Industries</members>
5       <name>Settings</name>
6   </types>
7   <version>47.0</version>
8</Package>