ProductDetails
RIXML 2.5 Element
Required container element for product metadata with mandatory publicationDateTime attribute. Contains required ProductCategory and optional ProductFocus, ProductSeries, EntitlementGroup, and ProductName elements.
Usage
Required element within Context, appearing exactly once. Must have publicationDateTime attribute and contain ProductCategory child. Other children optional.
Business Context
Central to research product categorization and timing, supporting content organization, publication tracking, and distribution workflow management in research systems.
Where It Fits
Definition
| Type | ProductDetailsType |
| Namespace | http://www.rixml.org/2017/9/RIXML |
| Min Occurs | 1 |
| Max Occurs | 1 |
Attributes
publicationDateTimedateTime |
Indicates the date and time at which the product was officially published. This is the date and time that would appear on the product itself, or be displayed to a reader. It is expressed using ISO 8601 as refined by the World Wide Web Consortium's note http://www.w3.org/TR/NOTE-datetime. In addition, RIXML requires the use of Zulu time or Z-time (GMT +/- n hours:minute:seconds). All times are absolute and easier to compute, rather than using a relative (i.e. 08:30 +5) time. requiredSince 2.1 |
periodicalIndicatorYesNoEnum |
Indicates whether or not the content is a periodical. optionalSince 2.1 |
Children
ProductCategorystring1..1 |
requiredSince 2.1 |
ProductFocusstring0..unbounded |
optionalSince 2.1 |
ProductSeries(complex)0..unbounded |
optionalSince 2.1 |
EntitlementGroup(complex)0..unbounded |
optionalSince 2.1 |
ProductNamestring0..1 |
optionalSince 2.1 |
Example
<ProductDetails publicationDateTime="2024-01-15T09:30:00Z">
<ProductCategory> ... </ProductCategory>
</ProductDetails>Version History
Unchanged since introduction in RIXML 2.1
Business Rules
Years in date/time values must be expressed using exactly four digits
Months in date/time values must be expressed using exactly two digits with leading zeros when necessary
Days in date/time values must be expressed using exactly two digits with leading zeros when necessary
Time conversion to UTC should only be done if the time is actually converted, not just the time zone indicator changed
Hour values in time components must use 00-23 format, not 24:00:00
The 'T' separator between date and time components must not be omitted
Additional punctuation or spaces must not be added to date/time values beyond ISO 8601 format
When the publication date is known but exact time is unknown, the actual time must be identified and specified rather than using default values
The ProductDetails element must include exactly one ProductCategory element
The ProductDetails element must contain exactly one ProductFocus element
Date/time values should include a time zone indicator
Time components should not be omitted from date/time values or defaulted to midnight (00:00:00)
Time values should not be set to one second before midnight (23:59:59)
Semantic Relationships
Requires2 relationships
Periodicity should only be used for reports that are genuinely published at regular fixed intervals, not for all reports published by an organization with regular frequency
RIXML Research Data Dictionary v2.5.1, p.18— Periodicity
UTC time zone indicator (Z) in publicationDateTime should only be used when time has actually been converted to UTC, not when using local time with UTC indicator
RIXML Implementation Guide v2.5.1, p.30— Date/time
Constrains4 relationships
Start date time must be later than the product publication date time
RIXML Research Data Dictionary v2.5.1, p.60— Elements and Attributes
End date time must be later than the product publication date time
RIXML Research Data Dictionary v2.5.1, p.60— Elements and Attributes
Date/time attributes must conform to ISO 8601 standard with specific formatting requirements including 4-digit years, 2-digit months and days, and time zone indicators
RIXML Implementation Guide v2.5.1, p.30— Date/time
TimeEntitlement endDateTime must be later in time than ProductDetails publicationDateTime
RIXML Level One Addendum v2.5, p.23— Research.Product.Context.ProductDetails.EntitlementGroup.Entitlement.TimeEntitlement
Blocks Action3 relationships
Using midnight (00:00:00) as default time in publicationDateTime causes research to appear incorrectly in chronological ordering systems, hiding content behind older research
RIXML Implementation Guide v2.5.1, p.30— Date/time
Using time just before midnight (23:59:59) in publicationDateTime may prevent research from displaying until nearly midnight, causing delayed visibility to users
RIXML Implementation Guide v2.5.1, p.30— Date/time
Level One specification excludes ProductSeries element from ProductDetails
RIXML Level One Addendum v2.5, p.21— Research.Product.Context.ProductDetails
Triggers Action1 relationship
Proper publication time tagging ensures research appears correctly in vendor chronological displays and portfolio manager alert systems
RIXML Implementation Guide v2.5.1, p.30— Date/time