EntitlementSettings

Represents an organization’s entitlement settings.

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

EntitlementSettings values are stored in the Entitlements.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

EntitlementSettings is available in API version 27.0 and later.

Fields

Field Name	Field Type	Description
assetLookupLimitedToActiveEntitlementsOnAccount	boolean	Indicates whether entitlements-related lookup filters on cases return only the assets related to the active entitlements on the case’s account (`true`) or not (`false`).
assetLookupLimitedToActiveEntitlementsOnContact	boolean	Indicates whether entitlements-related lookup filters on cases return only the assets related to the active entitlements on the case’s contact (`true`) or not (`false`).
assetLookupLimitedToSameAccount	boolean	Indicates whether entitlements-related lookup filters on cases return only the assets related to the case’s account (`true`) or not (`false`).
assetLookupLimitedToSameContact	boolean	Indicates whether entitlements-related lookup filters on cases return only the assets related to the case’s contact (`true`) or not (`false`).
enableEntitlements	boolean	Indicates whether entitlements are enabled (`true`) or not (`false`).
enableEntitlementVersioning	boolean	Indicates whether entitlement versioning is enabled (`true`) or not (`false`). This field is available in API version 28.0 and later.
entitlementLookupLimitedToActiveStatus	boolean	Indicates whether entitlements-related lookup filters on cases return only active entitlements (`true`) or not (`false`).
entitlementLookupLimitedToSameAccount	boolean	Indicates whether entitlements-related lookup filters on cases return only the entitlements related to the case’s account (`true`) or not (`false`).
entitlementLookupLimitedToSameAsset	boolean	Indicates whether entitlements-related lookup filters on cases return only the entitlements related to the case’s asset (`true`) or not (`false`).
entitlementLookupLimitedToSameContact	boolean	Indicates whether entitlements-related lookup filters on cases return only the entitlements related to the case’s contact (`true`) or not (`false`).

Declarative Metadata Sample Definition

This is a sample entitlements settings file.

Metadata API Developer Guide

File Suffix and Directory Location

Version

Fields

Declarative Metadata Sample Definition

See Also