RegionEntitlement
RIXML 2.5 Element
Contains geographic region specifications for access control purposes, serving as a container for Region elements that define the territorial scope of research entitlements.
Usage
Include at most one RegionEntitlement element within an Entitlement when geographic access restrictions apply. Must contain one or more child Region elements specifying allowed or restricted territories.
Business Context
Supports regulatory compliance by enabling research distributors to enforce geographic restrictions, manage cross-border distribution rules, and comply with regional securities regulations.
Specification Guide
Overview
RegionEntitlement is an optional container element within Entitlement that scopes research access to one or more geographic regions. It groups one or more Region child elements to express region-level (rather than country-level) distribution rights, enabling publishers to enforce regional licensing and regulatory restrictions across multinational territories (sources: data-dictionary-2.5.1 p.58, level-one-2.5 p.22).
Usage
RegionEntitlement appears at most once within an Entitlement and, when present, must contain one or more Region children that specify the geographic areas in scope (sources: level-one-2.3.1 p.22, level-one-2.5 p.22). It works in conjunction with the include/exclude semantics of the parent Entitlement (typically via includeExcludeIndicator) so that the listed regions are either granted or denied access [user-guide-2.2 p.39]. Use RegionEntitlement when distribution rights are defined at the regional level (e.g. EMEA, APAC); for country-specific restrictions use CountryEntitlement instead. Multiple Region children can be combined to build complex regional access patterns within a single entitlement rule [data-dictionary-2.4 p.55].
Rules
- MUSTRegionEntitlement MUST contain one or more Region child elements when present.[RIXML Research Data Dictionary v2.4 p.55] [RIXML Research Data Dictionary v2.5.1 p.58] [RIXML Level One Addendum v2.5 p.22] [RIXML User Guide v2.3.1 p.40]
- MAYRegionEntitlement MAY appear at most once within a parent Entitlement element.[RIXML Level One Addendum v2.3.1 p.22] [RIXML Level One Addendum v2.4 p.22] [RIXML Level One Addendum v2.5 p.22]
- INFORMATIVEThe include-or-exclude semantics of the listed regions are determined by the parent Entitlement (via includeExcludeIndicator); RegionEntitlement itself only enumerates the regions in scope.[RIXML User Guide v2.2 p.39]
Relationships
- child-ofEntitlement — RegionEntitlement is an optional child of Entitlement (within EntitlementGroup under ProductDetails) and inherits its include/exclude semantics.
- containsRegion — RegionEntitlement acts as a container for one or more Region elements that name the geographic regions to which the entitlement rule applies.
- descendant-ofEntitlementGroup — Ultimately scoped under EntitlementGroup via Entitlement, so it participates in the broader entitlement framework of a Product.
Where It Fits
Canonical Path
Children
Definition
| Type | |
| Namespace | http://www.rixml.org/2017/9/RIXML |
| Min Occurs | 1 |
| Max Occurs | 1 |
Attributes
No attributes defined for this element
Children
Region(complex)1..unbounded |
requiredSince 2.1 |
Example
<RegionEntitlement>
<Region> ... </Region>
</RegionEntitlement>Version History
Unchanged since introduction in RIXML 2.1
RegionEntitlement has been present consistently across the RIXML 2.x line. It is documented in the user guide for 2.2 (p.39) and in Level One schemas for 2.3, 2.3.1, 2.4 and 2.5 at the path Research.Product.Context.ProductDetails.EntitlementGroup.Entitlement.RegionEntitlement. Its structure and cardinality (optional, at most once per Entitlement, requiring one or more Region children) have remained stable across these versions; later data-dictionary editions (2.4, 2.5.1) clarify that it provides region-level control distinct from country-level control offered by CountryEntitlement.