RIXML Documentation

researchID

RIXML 2.5 Attribute

Required

Specification Guide

Overview

A required string attribute on the Research element that provides unique identification for a specific research bundle. UUID format is recommended to ensure global uniqueness across systems and time.

Usage

The researchID attribute appears only on the Research element. It identifies a particular bundling of products, distinguishing it from productID which identifies individual research items within that bundle.

Rules

  • SHOULDA Universal Unique Identifier (UUID) should be used for researchID to ensure uniqueness across space and time[RIXML Research Data Dictionary v2.5.1 p.21] [RIXML User Guide v2.1 p.14] [RIXML User Guide v2.2 p.14] [RIXML User Guide v2.3 p.14]
  • MUSTFor Level One compliance, researchID must be a UUID[RIXML Level One Addendum v2.2 p.10] [RIXML Level One Addendum v2.3 p.25] [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]
  • MUSTFor Level One compliance, researchID, productID, and resourceID must share the same UUID value[RIXML Level One Addendum v2.2 p.10] [RIXML Level One Addendum v2.3 p.25] [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

  • qualifiesProduct.productIDResearch ID identifies a particular bundling of products while Product ID identifies individual research ideas, enabling result set labeling in distribution systems
  • requiresProduct.productIDFor Level One compliance, researchID must match productID to ensure consistent identification
  • requiresResource.resourceIDFor Level One compliance, researchID must match resourceID to ensure consistent identification

Definition

Used consistently as `string` (required)

Researchstring

This is to facilitate the unique identification of a particular bundling of products. This is added with some forward thought to hypothetical research distribution systems that may wish to label and refer to result sets. 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 bundling of products. This is added with some forward thought to hypothetical research distribution systems that may wish to label and refer to result sets. 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

2.1Introduced in RIXML 2.1

Business Rules

MUST

The identifiers researchID, productID, and resourceID must share the same UUID value in Level One

level-one-restrictionidentifier-management
MUST

All identifiers in Level One must be UUIDs

level-one-restrictionidentifier-format
SHOULD

A Universal Unique Identifier (UUID) is recommended for researchID to ensure uniqueness across space and time

best-practiceidentifier-requirement

Design Decisions

researchID, productID, and resourceID must share the same value in Level One

Taking advantage of limited cardinality relationships to reduce the number of identifiers that must be generated by publishers and stored by vendors

RIXML Level One Addendum v2.5, p.25

Semantic Relationships

Qualifies1 relationship

Product/@productIDINFORMATIVE

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.21Research

Constrains1 relationship

For Level One compliance, the productID must be a UUID and should match the researchID value

RIXML Level One Addendum v2.5, p.6Research

Requires1 relationship

Level One requires researchID and productID to share the same UUID value

RIXML Level One Addendum v2.5, p.25Identifiers