ProductCategory
RIXML 2.5 Element
Required element specifying research format type using productCategory attribute from ProductCategoryEnum. Optional publisherDefinedValue attribute holds custom categories when productCategory is 'PublisherDefined'.
Describes the manner or format that information is presented within the product. Product categories include Comment, Report, Model, Chart, etc.
Usage
Required element within ProductDetails, appearing exactly once. Must have productCategory attribute. PublisherDefinedValue attribute required when using custom categories.
Business Context
Fundamental for research content classification, enabling consumers to filter and organize research by format type such as reports, comments, or models for workflow efficiency.
Specification Guide
Overview
ProductCategory specifies the format or presentation style of a research product — how information is structured and delivered, rather than what topics it covers. It distinguishes between formats such as Comment, Report, Model, Charts, Compilation, Presentation, Event, Primer, Directory, Glossary, and Overview, drawing its value from ProductCategoryEnum. The element sits within the Context package at Research.Product.Context.ProductDetails.ProductCategory and is one of the fundamental classifications used by downstream systems to route, render, and filter research content (sources: data-dictionary-2.5.1 p.49, level-one-2.5 p.21, user-guide-2.3.1 p.34).
Usage
Include exactly one ProductCategory inside each ProductDetails container. The productCategory attribute is mandatory and must take a value from ProductCategoryEnum. When no standard value fits, set productCategory to PublisherDefined and supply a descriptive label via the optional publisherDefinedValue attribute (sources: level-one-2.3 p.21, level-one-2.5 p.21, user-guide-2.3.1 p.34).
Typical pairings:
- A morning call note → productCategory="Comment"
- A full company or industry analysis → productCategory="Report"
- A spreadsheet or quantitative output → productCategory="Model"
- Visual-only deliverables → productCategory="Charts"
ProductCategory describes *format*, while sibling ProductFocus describes *subject scope* — the two are complementary and should both be populated where applicable [level-one-2.5 p.21].
Rules
- MUSTProductDetails must contain exactly one ProductCategory element.[RIXML Level One Addendum v2.3 p.21] [RIXML Level One Addendum v2.3.1 p.21] [RIXML Level One Addendum v2.4 p.21] [RIXML Level One Addendum v2.5 p.21] [RIXML Level One Addendum v2.2 p.26]
- MUSTProductCategory must carry a productCategory attribute whose value is drawn from ProductCategoryEnum.[RIXML Research Data Dictionary v2.4 p.47] [RIXML Research Data Dictionary v2.5.1 p.49] [RIXML Level One Addendum v2.5 p.21]
- SHOULDWhen productCategory is set to
PublisherDefined, the publisherDefinedValue attribute should be populated with the custom category label.[RIXML Level One Addendum v2.3 p.21] [RIXML User Guide v2.3.1 p.34] [RIXML Research Data Dictionary v2.4 p.47] - SHOULDPublishers should minimise use of the
PublisherDefinedvalue and prefer standard ProductCategoryEnum members to maximise interoperability across consumers.[RIXML Implementation Guide v2.5.1 p.19] - SHOULDMorning-call style notes should use
productCategory="Comment"rather thanReport, reflecting their brief commentary nature.[Morning Call Report (Basic) Sample v2.4]↗ - SHOULDIndustry-focused analytical documents should set
productCategory="Report"and use ProductFocus to indicate the industry scope.[Industry Report (Basic) Sample v2.4]↗
Relationships
- child-ofProductDetails — ProductCategory is a required single child of ProductDetails and qualifies the parent by declaring the product's format/presentation style.
- complementsProductFocus — Where ProductCategory declares the *format* of a product, sibling ProductFocus declares its *subject matter*. The two are typically populated together to give a complete classification.
- valued-byProductCategoryEnum — The productCategory attribute draws its allowed values from ProductCategoryEnum, which enumerates formats such as Comment, Report, Model, Charts, Compilation, Presentation, Event, Primer, Directory, Glossary, Overview, and PublisherDefined.
- constrained-byProductCategoryEntitlement — Consumer entitlements expressed through ProductCategoryEntitlement (introduced in 2.5) reference ProductCategoryEnum values to grant or restrict access to specific product categories.
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
productCategoryProductCategoryEnum |
The category that the product fits into. requiredSince 2.1 |
publisherDefinedValuestring |
For specifying other IM systems. optionalSince 2.1 |
Children
Contains text content (type: string)
This element's value is its text content. Attributes provide additional context.
Example
<ProductCategory productCategory="Value">ABC-123</ProductCategory>Version History
Unchanged since introduction in RIXML 2.1
2.1 — Structural refactor: the previously-nested productCategory child element was promoted to an attribute on ProductCategory to align with RIXML attribute-naming conventions. The enumerated value list and overall semantics were preserved [release-notes-2.1 p.4].
2.2 – 2.4 — Stable structure: required singleton within ProductDetails, productCategory attribute mandatory, optional publisherDefinedValue for custom categories (sources: level-one-2.2 p.26, level-one-2.3 p.21, level-one-2.4 p.21).
2.4 (Q2 2012 build-out) — ProductCategoryEnum expanded to forty-one standardised values, broadening coverage of research publication formats [quarterly-2012-q2 p.3].
2.5 — Element is referenced by the new ProductCategoryEntitlement facility, enabling entitlement rules to be expressed in terms of product category [release-notes-2.5 p.8]. Element structure itself unchanged.
3.0 (proposed) — Working-group discussion has considered applying a unified *List container style across classification elements such as Rating, Weighting, and ProductCategory to harmonise stylistic differences between 2.5 and 3.0 [meeting-2024-winter p.21].
Semantic Relationships
Qualifies1 relationship
Product type qualifies the nature of the research content, indicating whether it is a report, comment, model, or other publication format
RIXML Implementation Guide v2.5.1, p.17— Level One
Constrains3 relationships
Publishers should minimize use of PublisherDefined option and instead utilize standard enumerated values to ensure consistency across implementations
RIXML Implementation Guide v2.5.1, p.19— For content producers
ProductCategory attribute must take values from the ProductCategoryEnum enumeration
RIXML Level One Addendum v2.5, p.21— Research.Product.Context.ProductDetails.ProductCategory
Product category entitlement limits content access to specific product categories like Comment, Report, Model
RIXML Release Notes v2.5, p.8— Broadening support for different types of entitlements
Triggers Action1 relationship
When productCategory is PublisherDefined, the publisherDefinedValue attribute holds the custom category name
RIXML Level One Addendum v2.5, p.21— Research.Product.Context.ProductDetails.ProductCategory