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

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.

1<?xml version="1.0" encoding="UTF-8"?>
2<EntitlementSettings xmlns="http://soap.sforce.com/2006/04/metadata">   
3    <assetLookupLimitedToActiveEntitlementsOnAccount>
4        false
5    </assetLookupLimitedToActiveEntitlementsOnAccount>   
6    <assetLookupLimitedToActiveEntitlementsOnContact>
7        false
8    </assetLookupLimitedToActiveEntitlementsOnContact>   
9    <assetLookupLimitedToSameAccount>
10        false
11    </assetLookupLimitedToSameAccount>   
12    <assetLookupLimitedToSameContact>
13        false
14    </assetLookupLimitedToSameContact>   
15    <enableEntitlements>
16        true
17    </enableEntitlements>    
18    <entitlementLookupLimitedToActiveStatus>
19        false
20    </entitlementLookupLimitedToActiveStatus>   
21    <entitlementLookupLimitedToSameAccount>
22        false
23    </entitlementLookupLimitedToSameAccount>   
24    <entitlementLookupLimitedToSameAsset>
25        false
26    </entitlementLookupLimitedToSameAsset>   
27    <entitlementLookupLimitedToSameContact>
28        false
29    </entitlementLookupLimitedToSameContact>
30</EntitlementSettings>