RIXML Documentation

ActionEntitlement

RIXML 2.5 Element

Required

Entitlement restriction that specifies which actions research consumers are permitted to perform on research content, such as viewing, downloading, printing, or batch processing operations.

Usage

Used within Entitlement elements to control permitted actions. Requires action attribute from ActionEnum to specify the allowed action type. Works with parent Entitlement include/exclude logic to grant or restrict specific capabilities.

Business Context

Critical for intellectual property protection and license compliance by controlling how research content can be used, stored, and redistributed. Enables publishers to maintain control over their content while providing appropriate access levels.

Source:data-dictionary-2.5.1
Schema:RIXML-Common-2_5.xsd:2157

Specification Guide

Overview

ActionEntitlement is an entitlement sub-element that restricts which actions a research consumer is permitted to perform on research content — for example viewing, saving, printing, downloading, or batch operations. It exists to give publishers fine-grained, action-level control over how entitled content may be used, complementing other entitlement dimensions such as product category, asset class, and audience type. The element carries a required action attribute whose value is drawn from ActionEnum (e.g. View, ViewOffline, Save, Download, BatchDownload, Print, BatchPrint).

Usage

Use ActionEntitlement as an optional child of Entitlement (typically grouped inside an EntitlementGroup) to declare which operations end-users are permitted to perform on the associated research product. The action attribute is required and must reference a valid ActionEnum value. Multiple ActionEntitlement instances can be combined with other entitlement sub-elements — such as ProductCategoryEntitlement, AssetClassEntitlement, OrganizationTypeEntitlement, AudienceTypeEntitlement, RegionEntitlement, CountryEntitlement, SectorIndustryEntitlement, and TimeEntitlement — to express layered permission matrices. The parent Entitlement's include/exclude semantics determine whether the action is granted or denied.

Rules

Relationships

Where It Fits

Definition

Type
Namespacehttp://www.rixml.org/2017/9/RIXML
Min Occurs1
Max Occurs1
Content ModelText content (string)

Attributes

actionActionEnum

Indicates the specific action to be performed by the research consumer on the research product.

requiredSince 2.5

Children

Contains text content (type: string)

This element's value is its text content. Attributes provide additional context.

Example

<ActionEntitlement action="Value">ABC-123</ActionEntitlement>

Version History

Unchanged since introduction in RIXML 2.5

Introduced in RIXML v2.5 as one of several new optional sub-elements added to Entitlement — alongside ProductCategoryEntitlement, AssetClassEntitlement, and OrganizationTypeEntitlement — in response to member and non-member change requests since v2.4 and to support more granular distribution controls relevant to MiFID II compliance (sources: quarterly-2017-q2 p.8, quarterly-2017-q3 p.8, release-notes-2.5 p.8). Removed in RIXML v3.0. According to RC5 update notes, both ActionEntitlement and its underlying ActionEnum were removed from v3.0 due to lack of usage in practice [RIXML All-Member Meeting June 2025 p.35].

Design Decisions

Added ActionEntitlement element to broaden entitlement support for limiting permitted audience actions

Expands entitlement capabilities to restrict audience actions to specific subsets like View, Save, Print, and other permitted operations

RIXML Release Notes v2.5, p.8

Semantic Relationships

Constrains1 relationship

ActionEnumMUST

Action entitlement restricts permitted user actions to subsets like View, Save, Print

RIXML Release Notes v2.5, p.8Broadening support for different types of entitlements