CoverageUpdates
RIXML 2.5 Element
The root element for batches of coverage updates that enables publishers to communicate changes to their coverage universe using existing RIXML elements in a specialized structure
CoverageUpdates is the root tag for a batch of coverage updates. A coverage update gives a publisher the ability to communicate changes to its coverage universe. The common case would be a financial services firm updating the list of companies covered by a particular analyst.
Usage
Top-level element of the Coverage Updates sidecar schema containing required attributes coverageUpdatesID, createDateTime, and language, with multiple CoverageUpdate child elements
Business Context
Provides standardized mechanism for financial services firms to notify clients and aggregators about changes in analyst coverage assignments and research focus areas
Where It Fits
Canonical Path
Children
Definition
| Type | CoverageUpdatesType |
| Namespace | http://www.rixml.org/2017/9/RIXML |
| Min Occurs | 1 |
| Max Occurs | 1 |
Attributes
coverageUpdatesIDstring |
This is to facilitate the unique identification of a particular batch of coverage updates. Enables a consumer of this information to keep track of which batches have been applied to its database and which are duplicates. We recommend UUIDs to ensure uniqueness. requiredSince 2.5 |
createDateTimedateTime |
This marks the date/time at which this research bundle was formed. 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 |
Indicates the language of the RIXML document -- i.e. the language of the publisher-supplied tag values contained in the RIXML-based XML file for this research item. Described using the ISO 639-2/T Code. requiredSince 2.1 |
Children
CoverageUpdateCoverageUpdateType1..unbounded |
requiredSince 2.5 |
Example
<CoverageUpdates coverageUpdatesID="2024-01-15T09:30:00Z"
createDateTime="2024-01-15T09:30:00Z"
language="eng">
<CoverageUpdate> ... </CoverageUpdate>
</CoverageUpdates>Version History
Unchanged since introduction in RIXML 2.5
Business Rules
DateTime values for coverage updates must be expressed using ISO 8601 format with Zulu time representation
Language identification for coverage items must use ISO 639-2/T standard codes
Coverage update batches should use UUID identifiers to ensure uniqueness and prevent duplicate processing
Design Decisions
Created a dedicated sidecar schema for coverage updates that reuses existing RIXML elements while providing new top-level structure
Provides publishers with a standardized method to communicate coverage information changes to clients and aggregator partners
RIXML Research Data Dictionary v2.5.1, p.136
Coverage update batches require unique identification using recommended UUIDs
Allows consumers to track which batches have been processed and avoid duplicate processing
RIXML Research Data Dictionary v2.5.1, p.136
Semantic Relationships
Constrains1 relationship
The coverage updates batch identifier enables consumers to track which batches have been applied and identify duplicate batches
RIXML Research Data Dictionary v2.5.1, p.136— coverageUpdatesID