ProductDetails

Overview

ProductDetails is the container within Context that holds core descriptive metadata about a research product as a publication entity — most importantly when it was published, what category and focus it has, what series it belongs to, and which entitlement groups govern access. It carries the required publicationDateTime attribute (the official publication timestamp in ISO 8601 / Zulu time) and the optional periodicalIndicator attribute, and aggregates ProductCategory, ProductFocus, ProductSeries, EntitlementGroup, and ProductName (sources: data-dictionary-2.4 p.43, data-dictionary-2.5.1 p.46, user-guide-2.3 p.31).

Usage

ProductDetails appears at most once inside each Context and is optional in most profiles, though strongly recommended because it carries the publication timestamp that downstream distribution, archival, and compliance workflows depend on (sources: data-dictionary-2.5.1 p.46, user-guide-2.3.1 p.31). When present: - publicationDateTime is required and must reflect the official publication date/time that would appear on the product itself, expressed in ISO 8601 format with Zulu (UTC) time (sources: level-one-2.3 p.21, user-guide-2.3 p.31, data-dictionary-2.4 p.43). - periodicalIndicator indicates whether the product is part of a recurring series (e.g. a weekly note). It was required through version 2.2 and made optional in 2.3 (sources: release-notes-2.3 p.4, best-practices-guide p.17). - Exactly one ProductCategory child is required to describe the format/manner of presentation (sources: level-one-2.2 p.26, level-one-2.5 p.21). - ProductFocus identifies the primary topic; Level One requires exactly one with primaryIndicator=Yes [level-one-2.4 p.21]. - ProductSeries, EntitlementGroup, and ProductName are optional and may repeat where the full schema allows; ProductSeries is not part of Level One (sources: level-one-2.2 p.26, level-one-2.5 p.21). Typical placement is Research → Product → Context → ProductDetails.

Rules

• MUSTWhen ProductDetails is present, publicationDateTime MUST be supplied and reflect the official publication date/time of the product, expressed in ISO 8601 with Zulu time.[RIXML Level One Addendum v2.2 p.26] [RIXML Level One Addendum v2.3 p.21] [RIXML User Guide v2.3 p.31] [RIXML Research Data Dictionary v2.4 p.43] [RIXML Research Data Dictionary v2.5.1 p.46]
• MUSTProductDetails MUST contain exactly one ProductCategory child element, which describes the format and manner in which the research content is presented.[RIXML Level One Addendum v2.2 p.26] [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]
• MUSTIn Level One, ProductDetails MUST contain exactly one ProductFocus element identifying the primary topic of the research, with primaryIndicator=Yes.[RIXML Level One Addendum v2.2 p.27] [RIXML Level One Addendum v2.4 p.21] [RIXML Level One Addendum v2.5 p.21]
• MUSTThrough RIXML 2.2, periodicalIndicator is required whenever ProductDetails is present.[RIXML Level One Addendum v2.2 p.26] [RIXML User Guide v2.1 p.30]
• MAYFrom RIXML 2.3 onward, periodicalIndicator is optional and MAY be omitted when accurate periodical status is not available; publishers should not populate it with a default value just to satisfy a schema requirement.[RIXML Release Notes v2.3 p.4] [Best Practices for Publishing RIXML p.17] [RIXML User Guide v2.3.1 p.31]
• SHOULDPublishers SHOULD omit optional ProductDetails attributes and children rather than populate them with default values when reliable data is unavailable, because inaccurate tags are worse than absent tags.[RIXML Release Notes v2.3 p.2] [Best Practices for Publishing RIXML p.17]
• INFORMATIVEThe ProductSeries child of ProductDetails is not part of the Level One profile and is not required at that conformance level; it remains available in the full schema.[RIXML Level One Addendum v2.2 p.26] [RIXML Level One Addendum v2.3 p.21] [RIXML Level One Addendum v2.4 p.21] [RIXML Level One Addendum v2.5 p.21]
• MUSTAt most one ProductDetails element may appear per Context.[RIXML Level One Addendum v2.3 p.21] [RIXML Level One Addendum v2.5 p.21] [RIXML User Guide v2.3 p.31]

Relationships

• child-ofContext — ProductDetails is an optional child of Context and the principal carrier of product-level metadata within the Context package.
• requiresProductCategory — ProductDetails requires exactly one ProductCategory child, which classifies the format and presentation manner of the research.
• containsProductFocus — ProductDetails contains one or more ProductFocus elements identifying the primary topic(s) of the research; Level One requires exactly one with primaryIndicator=Yes.
• containsProductSeries — ProductDetails may contain zero or more ProductSeries elements expressing series membership; not required in Level One.
• containsEntitlementGroup — ProductDetails may contain zero or more EntitlementGroup children that scope access to the product.
• containsProductName — ProductDetails may include an optional ProductName to express proprietary branding or series identification.
• constrainsProductDetails.publicationDateTime — publicationDateTime is a required attribute conveying the official publication timestamp that would appear on the product.
• constrainsProductDetails.periodicalIndicator — periodicalIndicator flags whether the product is part of a recurring series; required through 2.2, optional from 2.3 onward.