Metadata API Developer’s Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

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

ActivitiesSettings

Represents an organization’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 more details.

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 is only one settings file for each settings component.

Version

ActivitiesSettings is available in API versions 28.0 and later.

Fields

Settings for all types listed below are controlled on the Activity settings page or the User Interface settings page as noted.

Field Name Field Type Description
enableActivityReminders boolean Enables popup activity reminders for an organization.

Administrators control this field on the Activity settings page.
enableClickCreateEvents boolean 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. Administrators use a mini page layout to configure the fields shown in the overlays. Does not support recurring events or multi-person events.

Administrators control this field on the User Interface settings page.
enableDragAndDropScheduling boolean 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. Administrators use a mini page layout to configure the fields shown in the overlays.

Administrators control this field on the User Interface settings page.
enableEmailTracking boolean Enables tracking of outbound HTML emails if an organization uses HTML email templates.

Administrators control this field on the Activity settings page.
enableGroupTasks boolean Lets users assign independent copies of a new task to multiple users.

Administrators control this field on the Activity settings page.
enableListViewScheduling boolean Extends the functionality of enableDragAndDropScheduling and enableClickCreateEvents to list view calendars.

Administrators control this field on the User Interface settings page.
enableMultidayEvents boolean Enables creation of events that end more than 24 hours after they start.

Administrators control this field on the Activity settings page.
enableRecurringEvents boolean Enables creation of events that repeat at specified intervals.

Administrators control this field on the Activity settings page.
enableRecurringTasks boolean Enables creation of tasks that repeat at specified intervals.

Administrators control this field on the Activity settings page.
enableSidebarCalendarShortcut boolean In the sidebar, displays a shortcut link to a user’s last-used calendar view.

Administrators control this field on the Activity settings page.
enableSimpleTaskCreateUI boolean Allows administrators to specify whether tapping New Task in Salesforce1 opens a regular task record edit page or a page that displays key task fields first.

Administrators control this field on the Activity settings page.
enableUNSTaskDelegatedToNotifications boolean On the Activity settings page, exposes a setting for administrators to hide or show a user setting that lets individual users enable or disable email notifications when tasks are assigned to them.
meetingRequestsLogo string 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.

Administrators control this field on the Activity settings page.
showCustomLogoMeetingRequests boolean 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.

Administrators control this field on the Activity settings page.
showEventDetailsMultiUserCalendar boolean Displays event details on-screen rather than in hover text.

Administrators control this field on the Activity settings page.
showHomePageHoverLinksForEvents boolean 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.

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

Administrators control this field on the User Interface settings page.
showMyTasksHoverLinks boolean 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.

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

Administrators control this field on the User Interface settings page.
showRequestedMeetingsOnHomePage boolean In the Calendar on the Home tab, displays the Requested Meetings subtab, listing the meetings a user has requested but not confirmed. Disabling this feature removes the New Meeting Request button from the calendar on the Home tab.

Administrators control this field on the Activity settings page.

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>

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    <allowUsersToRelateMultipleContactsToTasksAndEvents>true</allowUsersToRelateMultipleContactsToTasksAndEvents>
4    <enableActivityReminders>true</enableActivityReminders>
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    <enableRecurringTasks>true</enableRecurringTasks>
13    <enableSidebarCalendarShortcut>true</enableSidebarCalendarShortcut>
14    <meetingRequestsLogo>Folder02/logo03.png</meetingRequestsLogo>
15    <showCustomLogoMeetingRequests>true</showCustomLogoMeetingRequests>
16    <showEventDetailsMultiUserCalendar>true</showEventDetailsMultiUserCalendar>
17    <showHomePageHoverLinksForEvents>true</showHomePageHoverLinksForEvents>
18    <showMyTasksHoverLinks>true</showMyTasksHoverLinks>
19    <showRequestedMeetingsOnHomePage>true</showRequestedMeetingsOnHomePage>
20</ActivitiesSettings>