RIXML Documentation

StatusTypeEnum

RIXML 2.5 Enumeration

11 values

Defines the publication lifecycle states for research products, encompassing workflow stages from internal development through final distribution. Includes standard publishing states plus specialized values for revision management, content recall, and metadata-only updates.

Usage

Required enumeration for StatusInfo elements, with exactly one status marked as current per product. Used throughout product lifecycle management to track publication workflow states and communicate distribution intentions to consuming systems.

Business Context

Fundamental for research workflow management and distribution control. Enables publishers to manage content through approval processes, handle revisions appropriately, and provide clear signals to distribution platforms about content handling requirements, particularly for timeline placement and re-transmission scenarios.

Source:data-dictionary-2.5.1
Schema:RIXML-datatypes-2_5.xsd:58

Where It Fits

Elements using this type (1)

Definition

Base Typestring

Enumeration Values

Pending
Pending

Research product awaiting approval for release and restricted to internal use only

Use when a product has been created but has not yet received final approval for external distribution [RIXML Research Data Dictionary v2.5.1 p.124]

ActiveSince 2.1
Revised
Revised

Research product that represents an updated version of a previously published product

Use when publishing an updated version of existing research, regardless of whether changes are material or not [RIXML Research Data Dictionary v2.5.1 p.124]

ActiveSince 2.1
Recalled
Recalled

Research product that has been withdrawn from circulation by the publisher

Use when a publisher needs to retract a previously published product due to errors or other issues [RIXML Research Data Dictionary v2.5.1 p.124]

ActiveSince 2.1
Deleted
Deleted

Research product designated for removal from databases

Use to signal that a product should be permanently removed from recipient systems [RIXML Research Data Dictionary v2.5.1 p.124]

ActiveSince 2.1
Published
Published

Research product being made available for the first time

Use when distributing a completely new research product that has never been published before [RIXML Research Data Dictionary v2.5.1 p.124]

ActiveSince 2.1
Rebroadcast
Rebroadcast

Research product being redistributed in identical form to its original publication

Use when sending the same product again without any changes to content or metadata [RIXML Research Data Dictionary v2.5.1 p.124]

ActiveSince 2.1
Released
Released

Previously published research product being made available when publication and release times differ

Use when there is a time gap between when a product was officially published and when it becomes available to recipients [RIXML Research Data Dictionary v2.5.1 p.124]

ActiveSince 2.1
BackFilled
Back Filled

Previously published research product being retransmitted and inserted into timelines at its original publication date rather than current transmission date

Use when re-sending historical research that should maintain its original chronological position in recipient systems [RIXML Research Data Dictionary v2.5.1 p.124]

ActiveSince 2.5
TagsUpdated
Tags Updated

Research product where only metadata indexing information has been updated without changes to payload files

Use when sending updated RIXML tags without retransmitting large payload files, improving transmission efficiency [RIXML Research Data Dictionary v2.5.1 p.124]

ActiveSince 2.5
RevisedMaterialChange
Revised Material Change

Research product revision containing significant changes that warrant moving the product to the top of chronological timelines

Use when revisions contain substantial content changes that should be prominently featured in recipient systems [RIXML Research Data Dictionary v2.5.1 p.124]

ActiveSince 2.5
RevisedNoMaterialChange
Revised No Material Change

Research product revision containing only minor changes that should not affect chronological positioning in recipient systems

Use when revisions contain only minor corrections or updates that do not warrant timeline prominence [RIXML Research Data Dictionary v2.5.1 p.124]

ActiveSince 2.5

Examples

<!-- Example usage of StatusTypeEnum enumeration -->
<element type="StatusTypeEnum">Pending</element>

Version History

2.1
+Introduced
2.5
+Added values: BackFilled, TagsUpdated, RevisedMaterialChange, RevisedNoMaterialChange

Business Rules

MUST

Products with status type 'Pending' are designated for internal use only and are awaiting approval for release

statusinternal-useapproval
SHOULD

When using status type 'BackFilled', the product should be inserted into timelines at its original publication date rather than appearing at the current transmission date

statuschronologyback-filling
SHOULD

Status type 'TagsUpdated' should be used when only updating indexing information without updating payload files to improve transmission efficiency

statusefficiencymetadata-only
SHOULD

Publishers should distinguish between material and non-material revisions using 'RevisedMaterialChange' and 'RevisedNoMaterialChange' status types to help platforms make timeline decisions

statusrevision-classificationplatform-behavior
SHOULD

Publishers should use the TagsUpdated status type when only indexing information in the RIXML file is modified without updating payload files

status-managementefficiency
SHOULD

Publishers should specify whether revisions contain material changes by using RevisedMaterialChange or RevisedNoMaterialChange instead of generic Revised

status-managementmateriality

Design Decisions

Added 'TagsUpdated' enumeration value to StatusTypeEnum to indicate when only indexing information has been updated without changing payload files

Improves transmission efficiency by eliminating unnecessary re-sending of large payload files when only tags change, and explicitly informs receivers not to expect payload file updates to avoid false failures

RIXML Release Notes v2.5, p.6

Added 'RevisedMaterialChange' enumeration value to StatusTypeEnum to explicitly indicate revisions containing at least one material change

Provides platforms with sufficient information to make meaningful decisions about positioning revisions in timelines, distinguishing material from non-material changes

RIXML Release Notes v2.5, p.7

Added 'RevisedNoMaterialChange' enumeration value to StatusTypeEnum to explicitly indicate revisions with no material changes

Provides platforms with sufficient information to make meaningful decisions about positioning revisions in timelines, distinguishing non-material from material changes

RIXML Release Notes v2.5, p.7

Semantic Relationships

Triggers Action1 relationship

When a product replaces another product to correct errors, it effectively causes the earlier product to be recalled or superseded

RIXML Research Data Dictionary v2.5.1, p.96Replaces

Contrasts With1 relationship

BackFilled status prevents products from appearing at the top of current timelines while Published status allows normal timeline positioning

RIXML Research Data Dictionary v2.5.1, p.124BackFilled

Blocks Action2 relationships

ResourceMUST

TagsUpdated status indicates no payload file transmission is expected, preventing unnecessary resource transfers

RIXML Research Data Dictionary v2.5.1, p.124TagsUpdated

ResourceSHOULD

When tags are updated without payload changes, this status prevents unnecessary re-transmission of large payload files

RIXML Release Notes v2.5, p.6When only the tags are changed, not the payload

Mutually Exclusive With2 relationships

Material and non-material revision statuses distinguish the significance of changes to help platforms make timeline positioning decisions

RIXML Research Data Dictionary v2.5.1, p.124RevisedMaterialChange

These two status values provide opposite indications about whether material changes occurred in a revision

RIXML Release Notes v2.5, p.7Need to distinguish revisions with and without material changes

Narrows3 relationships

RevisedMaterialChange provides more specific distinction than the general Revised status for platform timeline management

RIXML Research Data Dictionary v2.5.1, p.124RevisedMaterialChange

The material change variant provides more specific information than the generic revised status

RIXML Release Notes v2.5, p.7Need to distinguish revisions with and without material changes

The no-material-change variant provides more specific information than the generic revised status

RIXML Release Notes v2.5, p.7Need to distinguish revisions with and without material changes

Constrains2 relationships

StatusInfo statusType attribute must take values from StatusTypeEnum enumeration

RIXML Level One Addendum v2.5, p.24Research.Product.StatusInfo

This enumeration value specifically guides the statusType attribute to indicate metadata-only updates

RIXML Release Notes v2.5, p.6When only the tags are changed, not the payload