ActivitiesSettings

Represents an org’s activity settings, and its user interface settings for the calendar.

Use the ActivitiesSettings component type to control the following activity settings:

  • Configure group and recurring tasks, recurring and multiday events, and email tracking
  • Relate multiple contacts to tasks and events (shared activities)
  • Display custom logos in meeting requests

Also use the ActivitiesSettings component type to control user interface settings for the calendar, including hover links and drag-and-drop editing.

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

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

ActivitiesSettings values are stored in the Activities.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

Version 

Introduced in API version 28.0.

Fields 

allowUsersToRelateMultipleContactsToTasksAndEvents 

  • Type: boolean
  • Required: No
  • Description: This field indicates whether Shared Activities is enabled. When the value is true, allows users to relate multiple contacts to a task or event.

Beginning with API v36.0, this field is read-only in all versions of the API. You can’t change the value of this field. Even though this field was updateable before Spring ‘16, changing this field’s value wasn’t supported and could have resulted in an incorrect integration. If you have code in older API versions that changes the value of this field, ensure that you update that code to prevent any errors.

Important

autoRelateEventAttendees 

  • Type: boolean

  • Required: No

  • Introduced: API version 42.0

  • Description: When users add attendees to events, events are automatically related to up to 50 contacts or one lead. An attendee is matched by their email address to a contact or lead.

    Admins control this field on the Activity Settings page.

enableActivityReminders 

  • Type: boolean

  • Required: No

  • Description: Enables popup activity reminders for an organization.

    Admins control this field on the Activity Settings page.

enableCalendarHomeLWC 

  • Type: boolean

  • Required: No

  • Description: Enables Lightning Web Components for Calendar. Increases the default item limit in Calendar Home and applies styling enhancements to improve readability.

    Admins control this field on the Activity Settings page.

enableClickCreateEvents 

  • Type: boolean

  • Required: No

  • Description: Lets users create events in day and weekly calendar views by double-clicking a specific time slot and entering the details of the event in an overlay. Hovering over an event displays an overlay where users can view the event details or delete the event without leaving the page. Admins use a mini page layout to configure the fields shown in the overlays. Doesn’t support recurring events or multi-person events.

    Admins control this field on the User Interface settings page.

enableDragAndDropScheduling 

  • Type: boolean

  • Required: No

  • Description: Lets users create events associated with records by dragging a record from a list view onto a calendar view and entering the details of the event in an overlay. Hovering over an event displays an overlay where users can view the event details or delete the event without leaving the page. Admins use a mini page layout to configure the fields shown in the overlays.

    Admins control this field on the User Interface settings page.

enableEmailTracking 

  • Type: boolean

  • Required: No

  • Description: Enables tracking of outbound HTML emails if an organization uses HTML email templates.

    Admins control this field on the Activity Settings page.

enableFlowTaskNotifsViaApex 

  • Type: boolean
  • Required: No
  • Description: If Apex invokes Process Builder to create a task, determines whether an email is sent (true) or not (false).

enableGroupTasks 

  • Type: boolean

  • Required: No

  • Description: Lets users assign independent copies of a new task to multiple users.

    Admins control this field on the Activity Settings page.

enableHideChildEventsPreference 

  • Type: boolean
  • Required: No
  • Introduced: API version 50.0
  • Description: Enables hiding child events from the calendar or activity views. This setting is useful if you have complex event hierarchies and want to simplify the views by hiding less relevant details. Admins control this field on the Activity Settings page.

enableListViewScheduling 

  • Type: boolean

  • Required: No

  • Description: Extends the functionality of enableDragAndDropScheduling and enableClickCreateEvents to list view calendars.

    Admins control this field on the User Interface settings page.

enableLogNote 

  • Type: boolean
  • Required: No
  • Description: Enables the option to create and associate a note on an existing record.

enableMLSingleClientProfile 

  • Type: boolean
  • Required: No
  • Introduced: API version 50.0
  • Description: Enable creating a client profile using machine learning. When this setting is enabled, Salesforce uses machine learning algorithms to analyze and consolidate client data, providing a more comprehensive client profile. This can help sales and service teams to better understand their clients and provide more personalized interactions. Admins control this field on the Activity Settings page.

enableMultidayEvents 

  • Type: boolean

  • Required: No

  • Description: Enables creation of events that end more than 24 hours after they start.

    Admins control this field on the Activity Settings page.

enableRecurringEvents 

  • Type: boolean

  • Required: No

  • Description: Enables creation of events that repeat at specified intervals.

    Admins control this field on the Activity Settings page.

enableRecurringTasks 

  • Type: boolean

  • Required: No

  • Description: Enables creation of tasks that repeat at specified intervals.

    Admins control this field on the Activity Settings page.

enableRollUpActivToContactsAcct 

  • Type: boolean
  • Required: No
  • Introduced: API version 47.0
  • Description: Enables a contact’s activities to be rolled up and displayed on the contact’s primary account. Default value is true.

enableSidebarCalendarShortcut 

  • Type: boolean

  • Required: No

  • Description: In the sidebar, displays a shortcut link to a user’s last-used calendar view.

    Admins control this field on the Activity Settings page.

enableSimpleTaskCreateUI 

  • Type: boolean

  • Required: No

  • Description: Allows admins to specify whether tapping New Task in Salesforce opens a regular task record edit page or a page that displays key task fields first.

    Admins control this field on the Activity Settings page.

enableTimelineCompDateSort 

  • Type: boolean

  • Required: No

  • Description: Allows admins to sort past activities by completed date (true). If false, activities are sorted by due date.

    Admins control this field on the Activity Settings page.

enableUNSTaskDelegatedToNotifications 

  • Type: boolean
  • Required: No
  • Description: On the Activity Settings page, exposes a setting for Admins to hide or show a user setting that lets individual users enable or disable email notifications when tasks are assigned to them.

enableUserListViewCalendars 

  • Type: boolean
  • Required: No
  • Introduced: API version 47.0
  • Description: Allows users to create and view user list view calendars in Lightning Experience.
  • Type: string

  • Required: No

  • Description: Available when showCustomLogoMeetingRequests is enabled. Uploads a custom logo. An administrator can select only a logo that has been uploaded to certain folders in the Documents tab.

    Admins control this field on the Activity Settings page.

showCustomLogoMeetingRequests 

  • Type: boolean

  • Required: No

  • Description: Displays a custom logo in meeting request emails and on a meeting’s Web page. Invitees see the logo when a user either invites them to an event or requests a meeting.

    Admins control this field on the Activity Settings page.

showEventDetailsMultiUserCalendar 

  • Type: boolean

  • Required: No

  • Description: Displays event details on-screen rather than in hover text.

    Admins control this field on the Activity Settings page.

showHomePageHoverLinksForEvents 

  • Type: boolean

  • Required: No

  • Description: In the calendar section of the Home tab:

    • When a user hovers over the subject of an event, a hover link displays an overlay with selected event details. (Hover links are always available in other calendar views.)
    • When a user clicks the subject of an event, displays the event detail page.

    Admins use a mini page layout to configure the fields shown in the overlay.

    Admins control this field on the User Interface settings page.

showMyTasksHoverLinks 

  • Type: boolean

  • Required: No

  • Description: In the My Tasks section of the Home tab and on the calendar day view:

    • When a user hovers over the subject of a task, a hover link displays an overlay with selected task details.
    • When a user clicks the subject of a task, displays the task detail page.

    Admins use a mini page layout to configure the fields shown in the overlay.

    Admins control this field on the User Interface settings page.

Declarative Metadata Sample Definition 

The following is an example of an activity settings file:

1<?xml version="1.0" encoding="UTF-8"?>
2<ActivitiesSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <enableActivityReminders>true</enableActivityReminders>
4    <autoRelateEventAttendees>true</autoRelateEventAttendees>
5    <enableClickCreateEvents>true</enableClickCreateEvents>
6    <enableDragAndDropScheduling>true</enableDragAndDropScheduling>
7    <enableEmailTracking>true</enableEmailTracking>
8    <enableGroupTasks>true</enableGroupTasks>
9    <enableListViewScheduling>true</enableListViewScheduling>
10    <enableMultidayEvents>true</enableMultidayEvents>
11    <enableRecurringEvents>true</enableRecurringEvents>
12    <enableRollUpActivToContactsAcct>true</enableRollUpActivToContactsAcct>
13    <enableRecurringTasks>true</enableRecurringTasks>
14    <enableTimelineCompDateSort>true</enableTimelineCompDateSort>
15    <enableUserListViewCalendars>true</enableUserListViewCalendars>
16    <enableSidebarCalendarShortcut>true</enableSidebarCalendarShortcut>
17    <meetingRequestsLogo>Folder02/logo03.png</meetingRequestsLogo>
18    <showCustomLogoMeetingRequests>true</showCustomLogoMeetingRequests>
19    <showEventDetailsMultiUserCalendar>true</showEventDetailsMultiUserCalendar>
20    <showHomePageHoverLinksForEvents>true</showHomePageHoverLinksForEvents>
21    <showMyTasksHoverLinks>true</showMyTasksHoverLinks>
22</ActivitiesSettings>

Example Package Manifest 

The following is an example package manifest used to deploy or retrieve the activity settings metadata for an organization:

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

Wildcard Support in the Manifest File 

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.