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

IdeasSettings

Represents the metadata used to manage settings for Ideas.

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

IdeasSettings is stored in one file named Ideas.settings in the settings folder of the corresponding package directory. The .settings files are different from other named components, as there is only one settings file for each settings component.

Version

IdeasSettings is available in API version 27.0 and later.

Ideas

Represents settings for Ideas and Idea Themes.

Fields

Field Name Field Type Description
enableIdeaThemes boolean Indicates whether Idea Themes is enabled (true) or not (false).
enableIdeas boolean Indicates whether Ideas is enabled (true) or not (false).
enableIdeasReputation boolean Indicates whether Reputation is enabled (true) or not (false). You can’t enable IdeasReputation without enabling the Ideas Reputation permission in your organization. This field is available in API version 28.0 and later.
enableChatterProfile boolean Indicates that the Chatter user profile is used for Ideas user profiles. If enableChatterProfile is true, the ideasProfilePage value must not be specified. If enableChatterProfile is false, then specify a ideasProfilePage value, otherwise the Ideas zone profile is used. This field is available in API version 29.0 and later.
ideasProfilePage string The name of the Visualforce page to use for a custom Ideas user profile, if enableChatterProfile is false. If enableChatterProfile is false, then specify a ideasProfilePage value, otherwise the Ideas zone profile is used. This field is available in API version 29.0 and later.
halfLife double Indicates how quickly old ideas drop in ranking on the Popular Ideas subtab. The half-life setting determines how the number of days after which old ideas drop in ranking on the Popular Ideas subtab, to make room for ideas with more recent votes. A shorter half-life moves older ideas down the page faster than a longer half-life.

Declarative Metadata Sample Definition

The following is an example ideas.settings metadata file:

1<?xml version="1.0" encoding="UTF-8"?>
2<IdeasSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3   <enableIdeaThemes>true</enableIdeaThemes>
4   <enableIdeas>true</enableIdeas>
5   <enableIdeasReputation>true</enableIdeasReputation>
6   <enableChatterProfile>false</enableChatterProfile>
7   <ideasProfilePage>name of Visualforce page</ideasProfilePage>
8   <halfLife>2.6</halfLife>
9</IdeasSettings>