AudienceTypeEntitlement
RIXML 2.5 Element
Specifies client category restrictions for research access through a mandatory audienceType attribute drawn from AudienceTypeEnum values, defining which client segments can access the content.
Usage
Include at most one AudienceTypeEntitlement element within an Entitlement when client-type restrictions apply. Select appropriate audience categories like Institutional, Retail, or Corporate based on intended recipient characteristics.
Business Context
Enables business model differentiation and regulatory compliance by controlling research distribution based on client sophistication levels, registration status, and service tier arrangements.
Specification Guide
Overview
AudienceTypeEntitlement is an entitlement constraint that restricts research access based on the classification of the intended audience, such as institutional clients, retail investors, press, or trading desks. It appears as an optional child of Entitlement within the entitlement structure of a Product, and uses values from AudienceTypeEnum to identify the permitted audience category. An optional flag indicates whether the audience is internal or external to the publisher's organization, and (from version 2.3 onward) a context attribute allows the entitlement to be scoped to a specific vendor platform.
Usage
Include AudienceTypeEntitlement within an Entitlement when access to the research Product should be restricted by audience category. The location in the document tree is Research/Product/Context/ProductDetails/EntitlementGroup/Entitlement/AudienceTypeEntitlement.
Key points:
- Cardinality is zero or one per Entitlement (sources: level-one-2.3.1 p.23, level-one-2.5 p.23).
- The audienceType attribute is required and must be drawn from AudienceTypeEnum (e.g. Institutional, Retail, Press, Trading).
- The optional external attribute (from YesNoEnum) indicates whether the audience is external to the publisher's organization [RIXML User Guide v2.2 p.38].
- The optional entitlementContext attribute (added in 2.3) carries a vendor platform mnemonic so that the entitlement is only applied by the intended vendor system [RIXML Release Notes v2.3 p.4].
- Multiple AudienceTypeEntitlement elements within an EntitlementGroup combine conjunctively along with sibling entitlement elements [RIXML User Guide v2.2 p.38].
Rules
- MUSTThe audienceType attribute is required and its value must come from AudienceTypeEnum.[RIXML Research Data Dictionary v2.4 p.54] [RIXML Research Data Dictionary v2.5.1 p.57] [RIXML Level One Addendum v2.5 p.23]
- MUSTAt most one AudienceTypeEntitlement may appear within a single Entitlement.[RIXML Level One Addendum v2.3.1 p.23] [RIXML Level One Addendum v2.5 p.23]
- SHOULDWhen expressing multiple vendor-specific entitlement codes, each code should appear in its own AudienceTypeEntitlement inside a separate Entitlement and EntitlementGroup, so that each vendor processes only its own codes.[RIXML Research Data Dictionary v2.5.1 p.20] [Best Practices for Publishing RIXML p.17]
Relationships
- child-ofEntitlement — AudienceTypeEntitlement occurs as an optional, single child of Entitlement and contributes an audience-category restriction to the conjunctive entitlement logic.
- contained-byEntitlementGroup — Transitively contained within an EntitlementGroup, where the surrounding group combines entitlement constraints to control access to the Product.
- uses-enumerationAudienceTypeEnum — The required audienceType attribute takes its value from AudienceTypeEnum, identifying the permitted audience category (e.g. institutional, retail, press, trading).
- qualified-byAudienceTypeEntitlement.entitlementContext — The optional entitlementContext attribute scopes the entitlement to a particular vendor platform, preventing other vendor systems from misapplying the code.
- qualified-byAudienceTypeEntitlement.external — The optional external attribute (a YesNoEnum value) indicates whether the audience is external to the publisher's organization.
Where It Fits
Canonical Path
Definition
| Type | |
| Namespace | http://www.rixml.org/2017/9/RIXML |
| Min Occurs | 1 |
| Max Occurs | 1 |
| Content Model | Text content (string) |
Attributes
audienceTypeAudienceTypeEnum |
Indicates the audience type that the author intended to address with the product. requiredSince 2.1 |
externalYesNoEnum |
Indicates whether the audience described by the audienceType attribute is internal to the publisher's organization or external. optional |
entitlementContextstring |
Indicates the context in which the entitlement applies -- typically given as a mnemonic for an individual vendor platform. Here, a vendor is defined as an organization outside the buy-side and sell-side community of financial services firms which provides platforms or tools used by participants in the investment research economy. optionalSince 2.3 |
Children
Contains text content (type: string)
This element's value is its text content. Attributes provide additional context.
Example
<AudienceTypeEntitlement audienceType="Value">ABC-123</AudienceTypeEntitlement>Version History
entitlementContext- 2.2 — AudienceTypeEntitlement is documented with two attributes: required audienceType (from AudienceTypeEnum) and optional external (from YesNoEnum) [RIXML User Guide v2.2 p.38]. - 2.3 — The optional entitlementContext attribute is added to allow association of entitlement codes with a specific vendor platform, addressing cross-vendor entitlement conflicts (sources: release-notes-2.3 p.4, best-practices-guide p.17). - 2.3.1 / 2.4 / 2.5 — The element's structure remains stable; documentation in these versions reinforces the conjunctive entitlement model and the recommendation to keep vendor-specific codes in separate entitlement groups (sources: user-guide-2.3.1 p.39, data-dictionary-2.4 p.54, data-dictionary-2.5.1 p.57, level-one-2.5 p.23).
Business Rules
Each vendor-specific entitlement code must appear in its own distinct AudienceTypeEntitlement element within separate Entitlement and EntitlementGroup elements
Design Decisions
Each vendor-specific entitlement code should appear in its own distinct AudienceTypeEntitlement element within separate Entitlement and EntitlementGroup elements
This structure ensures proper isolation and processing of different vendor entitlement systems while maintaining clear separation of access controls
RIXML Research Data Dictionary v2.5.1, p.20
Semantic Relationships
Requires1 relationship
Vendor-specific entitlement codes should each appear within their own distinct AudienceTypeEntitlement element within separate Entitlement and EntitlementGroup elements
RIXML Research Data Dictionary v2.5.1, p.20— How to Code Vendor-Specific Entitlement Codes