CoverageUpdate
RIXML 2.5 Element
An element representing individual changes to coverage assignments, typically used when financial firms update which analysts cover specific companies or sectors
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
Required child element of CoverageUpdates with multiple instances allowed, containing StatusInfo and CoveragePairing elements to specify coverage relationships
Business Context
Enables precise communication of coverage changes to aggregator partners and clients, supporting accurate routing of research content and analyst attribution
Specification Guide
Overview
CoverageUpdate represents an individual change to a research provider's coverage universe — typically a modification to which analyst or analyst group covers which company, security, or sector. It is the atomic unit of change within the coverage-updates sidecar schema, pairing a StatusInfo (describing the nature of the change) with one or more CoveragePairing elements (describing the affected covering-to-covered entity relationships) (sources: data-dictionary-2.4 p.132, data-dictionary-2.5.1 p.136).
Usage
CoverageUpdate appears as a repeatable child of CoverageUpdates, the root of the coverage-updates sidecar document. Each instance describes a single coverage change operation and must contain a StatusInfo indicating the change type (add, update, delete) followed by one or more CoveragePairing elements that link the CoveringEntities (e.g. analysts or groups) to the CoveredEntities (e.g. issuers or securities). The optional coverageUpdateID uniquely identifies an individual update so consumers can track which changes have already been processed and avoid duplicate application; UUIDs are the recommended format [RIXML Research Data Dictionary v2.5.1 p.136].
Rules
- MUSTEach CoverageUpdate must contain a StatusInfo element describing whether the change is an addition, modification, or removal.[RIXML Research Data Dictionary v2.5.1 p.137] [RIXML Research Data Dictionary v2.4 p.132]
- MUSTEach CoverageUpdate must contain one or more CoveragePairing elements defining the covering-to-covered entity relationships affected by the change.[RIXML Research Data Dictionary v2.5.1 p.136] [RIXML Research Data Dictionary v2.4 p.132]
- SHOULDPublishers should populate coverageUpdateID with a unique identifier (UUID recommended) to enable consumers to deduplicate and track processing of individual updates.[RIXML Research Data Dictionary v2.5.1 p.136]
Relationships
- contained-byCoverageUpdates — CoverageUpdate is a repeatable child of CoverageUpdates, which acts as the container for one or more coverage change notifications in the sidecar schema.
- requiresStatusInfo — CoverageUpdate requires a StatusInfo child to declare the type of coverage change (addition, update, or deletion) for analyst coverage tracking.
- requiresCoveragePairing — CoverageUpdate requires one or more CoveragePairing children defining the covering-to-covered entity relationship being modified.
- qualifiesCoverageUpdate.coverageUpdateID — The optional coverageUpdateID attribute uniquely identifies an individual coverage update so consumers can track processing state and avoid applying duplicates.
Where It Fits
Canonical Path
Children
Definition
| Type | CoverageUpdateType |
| Namespace | http://www.rixml.org/2017/9/RIXML |
| Min Occurs | 1 |
| Max Occurs | 1 |
Attributes
coverageUpdateIDstring |
This is to facilitate the unique identification of a particular individual coverage update. Enables a consumer of this information to keep track of which updates have been applied to its database and which are duplicates. We recommend UUIDs to ensure uniqueness. optionalSince 2.5 |
Children
StatusInfo(complex)1..unbounded |
For statusType attribute, use: Published=Add, Revised=Update, Deleted=Delete. requiredSince 2.5 |
CoveragePairingCoveragePairingType1..unbounded |
requiredSince 2.5 |
Example
<CoverageUpdate>
<StatusInfo> ... </StatusInfo>
<CoveragePairing> ... </CoveragePairing>
</CoverageUpdate>Version History
Unchanged since introduction in RIXML 2.5
CoverageUpdate is part of the Coverage Updates sidecar schema and is documented in both RIXML 2.4 (p.132) and 2.5/2.5.1 (p.136). Its structure — StatusInfo plus one or more CoveragePairing children with an optional coverageUpdateID — is consistent across these versions. The 2.5.1 dictionary makes the recommendation to use UUIDs for coverageUpdateID explicit [RIXML Research Data Dictionary v2.5.1 p.136].
Business Rules
Individual coverage updates should use UUID identifiers to enable tracking and duplicate prevention
Semantic Relationships
Requires1 relationship
Coverage updates must contain status information to indicate whether the coverage change is an addition, update, or deletion for analyst coverage tracking
RIXML Research Data Dictionary v2.5.1, p.137— CoverageUpdate
Constrains1 relationship
The coverage update identifier helps consumers manage which coverage updates have been processed and avoid processing duplicates
RIXML Research Data Dictionary v2.5.1, p.136— coverageUpdateID