productID
RIXML 2.5 Attribute
Specification Guide
Overview
The productID attribute is a required string that provides unique identification for individual research products. It is strongly recommended to use UUID format to ensure global uniqueness across distributed systems. This attribute appears on the Product element and serves as the primary identifier for discrete research ideas, enabling cross-referencing and relationship mapping between products.
Usage
The productID attribute appears exclusively on the Product element. It expects a string value, with UUID format strongly recommended for global uniqueness. Each product within a research bundle must have a distinct identifier. Multiple resources may share the same productID when they represent the same discrete research idea in different formats (such as translations or audio/transcript pairs).
Rules
- SHOULDA Universal Unique Identifier (UUID) is recommended for productID to ensure uniqueness across different systems[RIXML Research Data Dictionary v2.5.1 p.22] [RIXML User Guide v2.1 p.15] [RIXML User Guide v2.2 p.15] [RIXML User Guide v2.3 p.15]
- MUSTMultiple resources can share the same productID only when they represent the same discrete research idea in different forms[RIXML User Guide v2.1 p.15] [RIXML Getting Started Guide p.8]
- MUSTFor Level One compliance, the productID must be a UUID[RIXML Level One Addendum v2.2 p.11] [RIXML Level One Addendum v2.3 p.25] [RIXML Level One Addendum v2.4 p.25] [RIXML Level One Addendum v2.5 p.6]
- MUSTFor Level One compliance, the productID must share the same value as researchID and resourceID[RIXML Level One Addendum v2.2 p.10] [RIXML Level One Addendum v2.3.1 p.25] [RIXML Level One Addendum v2.4 p.25] [RIXML Level One Addendum v2.5 p.25]
Relationships
- qualifiesResearch.researchID — researchID identifies a particular bundling of products while productID identifies individual research ideas, enabling result set labeling in distribution systems
- requiresRelatedProduct — RelatedProduct references must link to valid product IDs through the relatedProductID attribute, establishing connections between associated research items
Definition
Used consistently as `string` (required)
Product string |
This is to facilitate the unique identification of a particular product. To ensure uniqueness it is recommended that a Universal Unique IDentifier (UUID) be used as the productID. UUIDs can be generated on any computer, regardless of platform or operating system. A UUID is a 128-bit (16-byte) integer that is virtually guaranteed to be unique in the world across space and time. The Open Software Foundation (OSF) created UUIDs, as part of their Distributed Computing Environment (DCE). required |
Documentation
This is to facilitate the unique identification of a particular product. To ensure uniqueness it is recommended that a Universal Unique IDentifier (UUID) be used as the productID. UUIDs can be generated on any computer, regardless of platform or operating system. A UUID is a 128-bit (16-byte) integer that is virtually guaranteed to be unique in the world across space and time. The Open Software Foundation (OSF) created UUIDs, as part of their Distributed Computing Environment (DCE).
Version History
The productID attribute has been consistently required across all RIXML versions from 2.1 through 2.5. The UUID recommendation has remained stable, though Level One compliance specifications have evolved to mandate UUID format rather than just recommend it. In version 3.0 drafts, the attribute appears on the ResearchProduct element with similar UUID requirements.
Business Rules
For Level One compliance, the productID must be a UUID and should match the researchID and resourceID
The identifiers researchID, productID, and resourceID must share the same UUID value in Level One
All identifiers in Level One must be UUIDs
A Universal Unique Identifier (UUID) is recommended for productID to ensure uniqueness across different systems
Design Decisions
The productID attribute must be a UUID and should be identical to researchID and resourceID for Level One compliance
To ensure unique identification and consistency across related elements in Level One implementations
RIXML Level One Addendum v2.5, p.6
productID must be a UUID in Level One
To ensure uniqueness and standardization, unlike the full schema which only recommends UUIDs
RIXML Level One Addendum v2.5, p.25
Semantic Relationships
Qualifies1 relationship
Research ID identifies a particular bundling of products while Product ID identifies individual research ideas, enabling result set labeling in distribution systems
RIXML Research Data Dictionary v2.5.1, p.21— Research
Requires3 relationships
Related product references must link to valid product IDs through the relatedProductID attribute, establishing connections between associated research items
RIXML Research Data Dictionary v2.5.1, p.23— RelatedProduct
Level One requires researchID and productID to share the same UUID value
RIXML Level One Addendum v2.5, p.25— Identifiers
Level One requires productID and resourceID to share the same UUID value
RIXML Level One Addendum v2.5, p.25— Identifiers
Constrains2 relationships
For Level One compliance, the productID must be a UUID and should match the researchID value
RIXML Level One Addendum v2.5, p.6— Research
For Level One compliance, the productID should match the resourceID value
RIXML Level One Addendum v2.5, p.6— Research