IndexID
RIXML 2.5 Element
Modern index identification mechanism using industry-standard identifier schemes such as CUSIP, RIC, and Bloomberg codes. Replaces deprecated name-based index referencing with precise symbolic identification.
Usage
Optional element within Index requiring idType from IssuerSecurityIDTypeEnum and idValue attributes. Includes publisherDefinedValue for custom identification schemes not covered by standard enumeration.
Business Context
Enables precise index referencing for benchmark analysis and performance comparison. Supports automated data integration with market data systems and reduces ambiguity in index-based research.
Specification Guide
Overview
IndexID provides standardised, symbol-based identification of a market index referenced in a research product, using an established identifier scheme such as CUSIP, SEDOL, RIC, or Bloomberg code. It is a child of Index and carries both a required identifier type (idType, drawn from IssuerSecurityIDTypeEnum) and a required identifier value (idValue), with an optional publisher-defined extension for custom schemes. The element was introduced in RIXML 2.3 to replace the earlier enumerated name-based approach to index identification, which proved impractical to maintain [RIXML Release Notes v2.3 p.5].
Usage
Use IndexID whenever research content references a specific market index that needs to be identified unambiguously for downstream processing, benchmarking, or cross-referencing.
- Cardinality: Optional within Index and repeatable (zero-to-many), allowing the same index to be tagged with multiple identifier schemes (e.g. a CUSIP and a Bloomberg code) (sources: release-notes-2.3 p.5, data-dictionary-2.4 p.49, data-dictionary-2.5.1 p.51).
- Required attributes: idType specifies the classification scheme; idValue holds the actual symbol.
- Custom schemes: When idType is set to PublisherDefined, use publisherDefinedValue (renamed idTypePublisherDefinedValue in the v3 draft) to label the custom identifier type (source: user-guide-2.3, p.35; data-dictionary-v3-draft, p.48).
- Preferred over legacy approaches: Choose IndexID in preference to the deprecated name attribute on Index and the deprecated PublisherDefinedValue child element (sources: release-notes-2.3 p.5, user-guide-2.3 p.32).
Rules
- SHOULDThe legacy
nameattribute on Index and its associatedPublisherDefinedValuechild element are deprecated; new content should identify indices using IndexID with appropriate idType and idValue values.[RIXML Release Notes v2.3 p.5] [RIXML User Guide v2.3 p.32] [RIXML Research Data Dictionary v2.5.1 p.48] - MUSTWhen idType is set to
PublisherDefined, publisherDefinedValue must be populated to identify the custom identifier scheme being used.[RIXML User Guide v2.3 p.35] [RIXML Research Suite Data Dictionary v3.0 (DRAFT) p.48]↗ - MUSTBoth idType and idValue must be present on every IndexID instance.[RIXML Research Suite Data Dictionary v3.0 (DRAFT) p.48]↗ [RIXML User Guide v2.3.1 p.35]
Relationships
- child-ofIndex — IndexID is an optional, repeatable child of Index providing identifier-based tagging of the index.
- replacesIndex.name — IndexID replaces the deprecated
nameattribute on Index for identifying indices, using symbolic identifiers such as CUSIP, SEDOL, RIC, or Bloomberg codes. - constrained-byIssuerSecurityIDTypeEnum — The idType attribute draws its permitted values from IssuerSecurityIDTypeEnum.
Where It Fits
Canonical Path
Definition
| Type | |
| Namespace | http://www.rixml.org/2017/9/RIXML |
| Min Occurs | 1 |
| Max Occurs | 1 |
Attributes
idTypeIssuerSecurityIDTypeEnum |
Indicates the protocol used for the index identifier (i.e. the classification scheme). Examples include CUSIP, RIC, BloombergCode, etc. required |
publisherDefinedValuestring |
For specifying other IM systems. optionalSince 2.1 |
idValuestring |
The actual symbol identifying the index. requiredSince 2.1 |
Children
No child elements defined
Example
<IndexID idType="Value"
idValue="example" />Version History
Unchanged since introduction in RIXML 2.3
- 2.3: IndexID introduced as a new zero-to-many child of Index, carrying required idType and idValue attributes and an optional publisherDefinedValue. Its introduction deprecated both the name attribute on Index and the older PublisherDefinedValue child element, because the enumerated list of index names had proven impractical to maintain [RIXML Release Notes v2.3 p.5].
- 2.3.1 – 2.4: No structural changes; documentation continued to emphasise IndexID as the preferred identification mechanism, with standard schemes such as CUSIP, RIC, and Bloomberg recommended (sources: user-guide-2.3.1 p.35, data-dictionary-2.4 p.49).
- 2.5: Element remained stable; the deprecation of the legacy name attribute and PublisherDefinedValue child of Index was reaffirmed [RIXML Research Data Dictionary v2.5.1 p.48].
- 3.0 (draft): Repositioned for use within an index list/wrapper context and within Focus when only identification (not full index details) is required. The publisher-defined attribute is renamed to idTypePublisherDefinedValue [RIXML Research Suite Data Dictionary v3.0 (DRAFT) p.48]↗.
Semantic Relationships
Replaced By2 relationships
The name attribute of Index is deprecated and should be replaced by using IndexID element instead
RIXML Research Data Dictionary v2.5.1, p.48— Index
The PublisherDefinedValue element in Index is deprecated and should be replaced by using IndexID element instead
RIXML Research Data Dictionary v2.5.1, p.48— Index