Entitlement
RIXML 2.5 Element
Defines access control parameters for research distribution through mandatory primaryIndicator and includeExcludeIndicator attributes. Acts as a container for specific entitlement types while providing priority and permission/restriction signals.
A container for more specific entitlement types. Mostly used as a convenient receptacle for attributes that apply to all lower entitlement types.
Usage
Include one or more Entitlement elements within EntitlementGroup. Set primaryIndicator for relative priority and includeExcludeIndicator to Include for permissions or Exclude for restrictions. Level One supports child elements for region, audience type, and time entitlements only.
Business Context
Enables sophisticated access control policies for research distribution, supporting regulatory compliance, business model enforcement, and client-specific content targeting in institutional environments.
Where It Fits
Definition
| Type | EntitlementType |
| Namespace | http://www.rixml.org/2017/9/RIXML |
| Min Occurs | 1 |
| Max Occurs | 1 |
Attributes
sequenceinteger |
Used to indicate any meaningful ordering of the Products contained in this Research item. Particularly useful in publishing compendium products made up of multiple sub-products. Ordering is ascending. optionalSince 2.1 |
primaryIndicatorYesNoEnum |
If necessary, indicates which entitlement is primary. required |
includeExcludeIndicatorIncludeExcludeEnum |
requiredSince 2.1 |
Children
AudienceTypeEntitlementstring0..1 |
optionalSince 2.1 |
CountryEntitlement(complex)0..1 |
optionalSince 2.1 |
SectorIndustryEntitlement(complex)0..1 |
optionalSince 2.1 |
TimeEntitlementstring0..1 |
optionalSince 2.1 |
RegionEntitlement(complex)0..1 |
optionalSince 2.1 |
ProductCategoryEntitlement(complex)0..1 |
optionalSince 2.5 |
AssetClassEntitlement(complex)0..1 |
optionalSince 2.5 |
OrganizationTypeEntitlementstring0..1 |
optionalSince 2.5 |
ActionEntitlementstring0..1 |
optionalSince 2.5 |
Example
<Entitlement primaryIndicator="Yes"
includeExcludeIndicator="Yes" />Version History
ProductCategoryEntitlement, AssetClassEntitlement, OrganizationTypeEntitlement, ActionEntitlementBusiness Rules
Each vendor-specific entitlement code must appear in its own distinct AudienceTypeEntitlement element within separate Entitlement and EntitlementGroup elements
Semantic Relationships
Constrains1 relationship
Individual entitlements within a single EntitlementGroup apply conjunctively (AND-ed together), while multiple EntitlementGroups apply disjunctively (OR-ed together)
RIXML Research Data Dictionary v2.5.1, p.51— EntitlementGroup
Blocks Action2 relationships
Level One does not allow CountryEntitlement elements as children of Entitlement
RIXML Level One Addendum v2.5, p.22— Research.Product.Context.ProductDetails.EntitlementGroup.Entitlement
Level One does not allow SectorIndustryEntitlement elements as children of Entitlement
RIXML Level One Addendum v2.5, p.22— Research.Product.Context.ProductDetails.EntitlementGroup.Entitlement