ProductSeries
RIXML 2.5 Element
Identification and organization information for research published as part of ongoing series or periodical publications. Includes series naming, volume numbering, and unique identification for series continuity across name changes.
Usage
Optional element for periodical research with required SeriesName and optional volume, number, and SeriesID attributes. Can include Periodicity child element to specify publication frequency.
Business Context
Important for managing recurring research publications and maintaining subscriber relationships with regular content series. Supports research archival systems and helps subscribers track ongoing publication series.
Specification Guide
Overview
ProductSeries identifies a research product as part of a recurring publication series or periodical, such as a weekly market commentary or quarterly sector review. It appears within ProductDetails and groups together the series naming, volume/number organisation, and publication frequency information needed to associate an individual research item with its broader publication lineage (sources: data-dictionary-2.5.1 p.50, user-guide-2.3.1 p.34).
Usage
ProductSeries is an optional child of ProductDetails and may appear multiple times when a product belongs to more than one series [data-dictionary-2.4 p.48]. When present, it requires a SeriesName (the human-readable title of the series) and supports optional volume and number attributes for hierarchical organisation of issues within a series. From v2.4 onward an optional SeriesID provides a stable identifier that persists across series renames (sources: release-notes-2.4 p.21, quarterly-2012-q3 p.3). A Periodicity child element may be included to declare publication frequency (e.g. weekly, quarterly). SeriesName values should remain consistent across all items in the same series so that consumers can reliably group and discover related issues (sources: user-guide-2.1 p.33, user-guide-2.3 p.34).
Rules
- MUSTWhen ProductSeries is used, the SeriesName must be supplied;
volume,number, and (from v2.4) SeriesID are optional.[RIXML Research Data Dictionary v2.5.1 p.50] [RIXML User Guide v2.3.1 p.34] - SHOULDSeriesName values should remain consistent across all items belonging to the same series so that consumers can group and identify them correctly.[RIXML User Guide v2.1 p.33] [RIXML User Guide v2.3 p.34] [RIXML Research Data Dictionary v2.4 p.48]
- MAYA SeriesID may be included within ProductSeries to maintain continuity when the series name changes during the publication's lifetime.[RIXML Quarterly Update 2012 Q3 p.4]↗ [RIXML Release Notes v2.4 p.21]
- INFORMATIVEProductSeries is not required by RIXML Level One; Level One implementations need not populate it, although the full schema continues to permit it.[RIXML Level One Addendum v2.2 p.26] [RIXML Level One Addendum v2.3 p.21] [RIXML Level One Addendum v2.3.1 p.21] [RIXML Level One Addendum v2.5 p.21]
Relationships
- child-ofProductDetails — ProductSeries is an optional, repeatable child of ProductDetails, used to attach series/periodical metadata to a product.
- containsPeriodicity — ProductSeries may contain a Periodicity child element to declare the publication frequency of the series.
- not-required-by-profileProductDetails — RIXML Level One does not require ProductSeries inside ProductDetails; it is treated as part of the fuller schema beyond the Level One subset.
Where It Fits
Canonical Path
Children
Definition
| Type | |
| Namespace | http://www.rixml.org/2017/9/RIXML |
| Min Occurs | 1 |
| Max Occurs | 1 |
Attributes
Children
Periodicitystring0..1 |
optionalSince 2.1 |
SeriesNamestring1..1 |
Indicates the name of the publication series. requiredSince 2.1 |
SeriesIDstring0..1 |
Since the name of a series may change over its lifetime, the SeriesID can be used to uniquely identify it. This tag gives the publisher the opportunity to maintain continuity in the series across name changes. optionalSince 2.4 |
Example
<ProductSeries>
<SeriesName> ... </SeriesName>
</ProductSeries>Version History
SeriesIDProductSeries is present in RIXML 2.1 through 2.5 with a stable core structure: a required SeriesName, optional volume and number attributes, and an optional Periodicity child (sources: user-guide-2.1 p.33, user-guide-2.3 p.34). In RIXML 2.4 a SeriesID was added so that publishers can maintain persistent series identity across name changes during the publication's lifetime (sources: release-notes-2.4 p.21, quarterly-2012-q3 p.3). This addition carried forward into 2.5 with no further structural changes [data-dictionary-2.5.1 p.50]. Across Level One profiles for 2.2, 2.3, 2.3.1, and 2.5 the element is consistently treated as outside the Level One required set (sources: level-one-2.2 p.26, level-one-2.3 p.21, level-one-2.3.1 p.21, level-one-2.5 p.21).
Design Decisions
ProductSeries element is excluded from Level One implementation
To reduce complexity and implementation costs for Level One compliance
RIXML Level One Addendum v2.5, p.21
Semantic Relationships
Blocks Action1 relationship
Level One specification excludes ProductSeries element from ProductDetails
RIXML Level One Addendum v2.5, p.21— Research.Product.Context.ProductDetails