RIXML Documentation

Security

RIXML 2.5 Element

Level OneRequired

Describes specific financial instrument with required primaryIndicator and optional action attributes for coverage, target price, and estimate changes. Level One excludes FinancialDates, SecurityType, SectorIndustry, and Weighting children.

Information about a particular security that describes the type of security and how to identify it. A security is always issued by an issuer, therefore, if a security is being mentioned, it must be attached to an Issuer element.

Usage

Required when SecurityDetails present, can appear multiple times. Must have primaryIndicator attribute. Optional coverageAction, targetPriceAction, and estimateAction attributes indicate publisher changes.

Business Context

Critical for security-specific research identification and change tracking, enabling investment professionals to monitor analyst actions and recommendations on specific financial instruments.

Source:level-one-2.5
Schema:RIXML-Common-2_5.xsd:1840

Specification Guide

Overview

The Security element describes an individual financial instrument — its identification, classification, and any analyst actions taken on it within a research product. It is the instrument-level counterpart to Issuer, representing the specific tradable item (a particular equity line, bond, derivative, etc.) issued by an entity, and it carries the actionable intelligence (ratings, target prices, estimates, coverage status) that drives investment decisions (sources: data-dictionary-2.5.1 p.55, user-guide-2.2 p.37). Because securities are always issued by an entity, Security is structurally subordinate to Issuer: it appears inside the SecurityDetails container, which in turn sits under an Issuer inside IssuerDetails (sources: data-dictionary-2.5.1 p.55, user-guide-2.2 p.37, level-one-2.5 p.13). Multiple Security elements may be present to describe several instruments issued by the same issuer (for example, common stock plus a related ADR or preferred line), with the primaryIndicator attribute distinguishing the featured security from those mentioned substantively but not centrally [level-one-2.4 p.13].

Usage

Use Security inside SecurityDetails whenever research discusses one or more specific instruments. The element supports unbounded occurrences within its parent, and when SecurityDetails is present it MUST contain at least one Security (sources: level-one-2.2 p.18, level-one-2.5 p.13). Required content at Level One compliance: - primaryIndicator attribute (Yes/No) - At least one SecurityID child with idType and idValue - Exactly one AssetClass child - Exactly one AssetType child (sources: level-one-2.5 pp.13–15, level-one-2.3.1 pp.13–15) Primary designation. When ProductFocus is set to Security, at least one Security must be marked primary via primaryIndicator="Yes" (sources: user-guide-2.2 p.37, data-dictionary-2.5.1 p.55). Featured securities should be flagged primary; securities discussed substantively but not centrally should be marked non-primary [level-one-2.2 p.19]. Action attributes. Optional attributes — coverageAction, ratingAction, targetPriceAction, estimateAction, and weightingAction — signal that the publisher is changing coverage, rating, target price, earnings estimate, or weighting for this security in this product. Use them only when an actual change is being signalled (sources: level-one-2.4 p.14, data-dictionary-2.5.1 p.55). Selectivity. Only include identifiers for securities (and their issuers) that are substantively discussed. Do not list securities that appear only in tables or are mentioned in passing — doing so creates metadata noise and misleads downstream consumers about report content [data-dictionary-2.5.1 p.17]. Typical children (full schema): SecurityID, SecurityFinancials, FinancialDates, SectorIndustry, AssetClass, AssetType, SecurityType, Rating, Weighting [data-dictionary-2.5.1 p.55].

Rules

  • MUSTEvery Security MUST be attached to an Issuer element, since securities are always issued by an issuing entity.[RIXML Research Data Dictionary v2.5.1 p.55] [RIXML User Guide v2.2 p.37] [RIXML Research Suite Data Dictionary v3.0 (DRAFT) p.55]
  • MUSTWhen SecurityDetails is present, it MUST contain at least one Security element.[RIXML Level One Addendum v2.2 p.18] [RIXML Level One Addendum v2.3 p.13] [RIXML Level One Addendum v2.3.1 p.13] [RIXML Level One Addendum v2.5 p.13]
  • MUSTSecurity MUST carry the primaryIndicator attribute, and at least one Security MUST be marked primary when ProductFocus is set to Security.[RIXML User Guide v2.2 p.37] [RIXML Research Data Dictionary v2.5.1 p.55] [RIXML Level One Addendum v2.3.1 p.13]
  • MUSTSecurity MUST contain at least one SecurityID child, with idType and idValue populated.[RIXML Level One Addendum v2.3 p.14] [RIXML Level One Addendum v2.3.1 p.14] [RIXML Level One Addendum v2.4 p.14] [RIXML Level One Addendum v2.5 p.14]
  • MUSTSecurity MUST contain exactly one AssetClass child and exactly one AssetType child to classify the instrument.[RIXML Level One Addendum v2.3 p.15] [RIXML Level One Addendum v2.3.1 p.15] [RIXML Level One Addendum v2.5 p.15]
  • SHOULDSecurity identification SHOULD include multiple universally accepted identifiers (e.g. CUSIP, SEDOL, ISIN, Bloomberg, RIC) via repeated SecurityID children, to ensure compatibility across vendor systems.[Best Practices for Publishing RIXML p.11]
  • SHOULDPublishers SHOULD NOT emit Security entries for instruments that are only mentioned briefly (for example, those appearing only in tables); only securities substantively discussed in the report should be tagged.[RIXML Research Data Dictionary v2.5.1 p.17]
  • INFORMATIVEAt Level One compliance, the child elements FinancialDates, SecurityType, SectorIndustry, and Weighting are not required under Security and need not be populated by Level One producers or consumed by Level One consumers. They MAY still appear without breaking compliance.[RIXML Level One Addendum v2.2 p.19] [RIXML Level One Addendum v2.3 p.13] [RIXML Level One Addendum v2.5 p.14]
  • INFORMATIVEWhen coverageAction, targetPriceAction, ratingAction, or estimateAction is present, it signals that the publisher is changing the corresponding coverage status, target price, rating, or earnings estimate for this security in this product.[RIXML Level One Addendum v2.4 p.14] [RIXML Research Data Dictionary v2.5.1 p.55]
  • SHOULDWhen the topic of the report carries an identifier — i.e. when Issuer, Security, or Index tag sets are present — the issuerType attribute SHOULD be supplied.[RIXML v3 Taxonomy Review Summary: Identifiers p.4]

Relationships

Where It Fits

Definition

TypeSecurityType
Namespacehttp://www.rixml.org/2017/9/RIXML
Min Occurs1
Max Occurs1

Attributes

targetPriceActionTargetPriceEnum

Highlights an action taken by the publisher. Indicates that the publisher is changing their target price estimate for a Security. Example: a publisher increases a target price for Security ABC to $100.

optionalSince 2.1
estimateActionEstimateEnum

If this financial value is an estimate, the estimateAction attribute can be used to indicate an action, such as reiterate or upgrade, that applies to this estimate. Intended to provide support for the case where an author is including more than one estimate action in the same report -- for example, reiterating his current fiscal year estimate and upgrading his next fiscal year estimate.

optionalSince 2.1
sequenceinteger

Used to indicate any meaningful ordering of the Products contained in this Research item. Particularly useful in publishing compendium products made up of multiple sub-products. Ordering is ascending.

optionalSince 2.1

Indicates the primary Security or Securities discussed in the research product. If the product is focused at the Security level (i.e. the ProductFocus tag is set to Security), then at least one Security must be marked as primary. Otherwise primaryIndicator is optional.

required
coverageActionCoverageActionEnum

Highlights an action taken by the publisher. Indicates that the publisher is changing the coverage status of a Security. Example: a publisher initiates coverage of Security ABC.

optionalSince 2.1
ratingActionRatingActionEnum

Highlights an action taken by the publisher. Indicates that the publisher is changing their rating on a Security. Example: a publisher downgrades Security ABC.

optionalSince 2.1
weightingActionWeightingActionEnum

Highlights an action taken by the publisher. Indicates that the publisher is changing the weighting of the security type.

optionalSince 2.1

Children

SecurityID(complex)1..unbounded
requiredSince 2.1
FinancialDatesstring0..1
optionalSince 2.1
SecurityFinancials(complex)0..unbounded
optionalSince 2.1
SectorIndustrySectorIndustryType0..unbounded
optionalSince 2.1
Weighting(complex)0..unbounded
optionalSince 2.1
SecurityNamestring0..1

The name of the Security.

optionalSince 2.1

Optional short name commonly used to identify the Security.

optionalSince 2.1
AssetClass(complex)1..1
requiredSince 2.1
AssetType(complex)1..1
requiredSince 2.1
SecurityType(complex)0..1
optionalSince 2.1
Rating(complex)0..unbounded
optionalSince 2.1

Example

<Security primaryIndicator="Yes">
  <SecurityID> ... </SecurityID>
  <AssetClass> ... </AssetClass>
  <AssetType> ... </AssetType>
</Security>

Version History

Unchanged since introduction in RIXML 2.1

Security is a long-standing core element present in all observed RIXML versions (2.2 through 2.5) with stable structural rules: it must attach to an Issuer inside SecurityDetails, must carry primaryIndicator, and must contain at least one SecurityID plus AssetClass and AssetType children (sources: user-guide-2.2 p.37, level-one-2.5 pp.13–15). - 2.2–2.3.1. Action attributes coverageAction, ratingAction, targetPriceAction, and estimateAction are defined to signal publisher changes [level-one-2.2 p.19]. - 2.4. Level One documentation continues to list coverageAction, targetPriceAction, and estimateAction as the principal action signals; ratingAction is no longer enumerated alongside them in the 2.4 Level One profile, though it remains in the full schema [level-one-2.4 p.13]. - 2.5 / 2.5.1. No structural change; documentation explicitly enumerates coverageAction, targetPriceAction, and estimateAction as the Level One action attributes [level-one-2.5 p.13]. The full data dictionary continues to support rating, weighting, target-price, and estimate actions [data-dictionary-2.5.1 p.55]. - 3.0 (draft). The v3 draft restructures children into explicit *list* aggregations: SecurityID occurrences are wrapped in a SecurityIDList, with corresponding SecurityFinancialsList, RatingList, WeightingList, IndustryList, and AssetClassList wrappers; the primaryIndicator attribute is renamed isPrimary, and Security itself sits inside a SecurityList rather than SecurityDetails [data-dictionary-v3-draft p.55].

Business Rules

MUST

Weighting Action must not be used for individual securities, as it is reserved for asset allocation concepts related to industries, sectors, countries, regions, or asset classes

validationrestriction
MUST

A security is always issued by an issuer, therefore if a security is being mentioned, it must be attached to an Issuer element

structural-requirementvalidation
MUST

If the product is focused at the Security level (ProductFocus tag is set to Security), then at least one Security must be marked as primary

conditional-requirementvalidation
MUST

Security primaryIndicator attribute must be used to mark featured securities as primary and mentioned securities as non-primary

validationrequired-attribute
MUST

Level One compliance excludes FinancialDates, SecurityType, SectorIndustry, and Weighting elements as children of Security

validationlevel-one-complianceexclusion
MUST

Security element must contain at least one SecurityID element

validationrequired-element
MUST

Security element must contain single AssetClass element that acts as container for the assetClass attribute

validationrequired-element
MUST

Security element must contain single AssetType element that acts as container for the assetType attribute

validationrequired-element
SHOULD

When creating company reports, only one issuer or security should be marked as primary, except in rare cases such as merger reports discussing two companies equally

validationconditional-requirement
SHOULD

Company reports should not include identifiers for companies that are only mentioned briefly, such as those appearing only in tables

conditional-requirement
SHOULD

In Sector/Industry reports, all issuer and security identifiers must have their primaryIndicator set to No

validationconditional-requirement
SHOULD

Compilation reports should not include a focus element and must set all primaryIndicator attributes to No

validationconditional-requirement

Design Decisions

Security must be attached to an Issuer element

A security is always issued by an issuer, therefore if a security is being mentioned it must be attached to an Issuer element

RIXML Research Data Dictionary v2.5.1, p.55

At least one Security must be marked as primary when the product is focused at the Security level

When ProductFocus tag is set to Security, there must be at least one primary Security to indicate the main focus of the research product

RIXML Research Data Dictionary v2.5.1, p.56

Semantic Relationships

Contrasts With2 relationships

RatingINFORMATIVE

Rating represents the author's current opinion while rating action describes changes or restatements of that opinion such as upgrades or downgrades

RIXML Research Data Dictionary v2.5.1, p.19Rating versus Rating Action versus Weighting Action

When focus is SectorIndustry, the report emphasizes sector or industry analysis rather than individual securities mentioned

RIXML Research Data Dictionary v2.5.1, p.83SectorIndustry

Mutually Exclusive With1 relationship

Weighting action applies to asset allocation recommendations for industries, countries, or asset classes, while rating action applies to individual securities - they serve different analytical purposes

RIXML Research Data Dictionary v2.5.1, p.19Rating versus Rating Action versus Weighting Action

Requires1 relationship

IssuerMUST

Every security must be associated with an issuer element since securities are always issued by an issuer

RIXML Research Data Dictionary v2.5.1, p.55Security

Constrains5 relationships

At least one security must be marked as primary when product focus is set to Security level

RIXML Research Data Dictionary v2.5.1, p.56Elements and Attributes

If SecurityDetails element is present, this element must contain at least one Security element

RIXML Level One Addendum v2.5, p.13Research.Product.Context.IssuerDetails.Issuer.SecurityDetails

SecurityIDMUST

The Security element must contain at least one SecurityID element

RIXML Level One Addendum v2.5, p.14Research.Product.Context.IssuerDetails.Issuer.SecurityDetails.Security.SecurityID

AssetClassMUST

The Security element must contain a single AssetClass element

RIXML Level One Addendum v2.5, p.15Research.Product.Context.IssuerDetails.Issuer.SecurityDetails.Security.AssetClass

AssetTypeMUST

The Security element must contain a single AssetType element

RIXML Level One Addendum v2.5, p.15Research.Product.Context.IssuerDetails.Issuer.SecurityDetails.Security.AssetType

Replaces1 relationship

The ratingAction attribute within the Rating element is the preferred location for rating action specifiers, allowing multiple ratings to have independent actions

RIXML Research Data Dictionary v2.5.1, p.66Elements and Attributes