RIXML Documentation

primaryIndicator

RIXML 2.5 Attribute

Optional

Definition

Varies by element context

CountryYesNoEnum

Indicates the primary PersonGroup, when more than one are specified.

required
EntitlementYesNoEnum

Indicates the primary PersonGroup, when more than one are specified.

required
IssuerYesNoEnum

Indicates the primary PersonGroup, when more than one are specified.

required
OrganizationYesNoEnum

Indicates the primary PersonGroup, when more than one are specified.

required
PersonGroupYesNoEnum

Indicates the primary PersonGroup, when more than one are specified.

optional

Indicates the primary PersonGroup, when more than one are specified.

optional
ProductFocusYesNoEnum

Indicates the primary PersonGroup, when more than one are specified.

required
RegionYesNoEnum

Indicates the primary PersonGroup, when more than one are specified.

required
ResourceYesNoEnum

Indicates the primary PersonGroup, when more than one are specified.

required

Indicates the primary PersonGroup, when more than one are specified.

required
SecurityYesNoEnum

Indicates the primary PersonGroup, when more than one are specified.

required

Version History

2.1Introduced in RIXML 2.1

Business Rules

MUST

When multiple organizations collaborate on a product, exactly one must be designated as the primary publisher using primaryIndicator

validationconditional-requirement
MUST

At least one Resource element must have its primaryIndicator attribute set to Primary

validationconditional-requirement
MUST

When the ProductFocus focus attribute is set to Issuer, at least one Issuer must have primaryIndicator set to Yes

conditional-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

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

conditional-requirementvalidation
MUST

When a product is focused on the Region level (ProductFocus tag set to Region), at least one Region must be marked as primary using the primaryIndicator attribute

conditional-requirementfocus-consistency
MUST

When a product is focused on the SectorIndustry level (ProductFocus tag set to SectorIndustry), at least one SectorIndustry must be marked as primary

conditional-requirementfocus-consistency
MUST

For Level One compliance, Organization primaryIndicator attribute must be present and set to Yes

validationlevel-one-compliancerequired-attribute
MUST

For Level One compliance, PersonGroupMember primaryIndicator attribute is required despite being optional in the full schema

validationlevel-one-compliancerequired-attribute
MUST

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

validationrequired-attribute
MUST

When ProductFocus is used in Level One, the primaryIndicator attribute must be set to Yes

validationlevel-one-restriction
SHOULD

Primary authors are persons or groups who primarily drafted the report, while other contributors can be included but should not be marked as primary, and non-contributing team members should not be included

author-attributionprimary-designation
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

For company reports, all elements describing the primary company's characteristics (sector/industry, region, country) must have their primaryIndicator set to Yes

validationconditional-requirement
SHOULD

Sector/Industry reports must have a focus of SectorIndustry and set the primaryIndicator of the appropriate sector or industry to Yes

validationconditional-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
SHOULD

In compilation reports, no single person should be marked as primary author, and editors or compilers should not be listed as authors

validationauthorship-rule
SHOULD

Reports providing updates on multiple companies within an industry should have ProductFocus set to Issuer with all company primaryIndicators set to No

content-classificationconditional-requirement
SHOULD

Company reports primarily about one issuer should tag the primary company with primaryIndicator set to Yes and any mentioned competitors with primaryIndicator set to No

content-classificationconditional-requirement
SHOULD

Reports covering mergers should use the Subject tag MergerAcquisitionDivestiture and may have multiple companies tagged with primaryIndicator set to Yes

content-classificationsubject-tagging

Design Decisions

The primaryIndicator attribute must be present and set to 'Yes' for Organization elements in Level One

To ensure proper identification of the primary publisher organization

RIXML Level One Addendum v2.5, p.6

The primaryIndicator attribute is required for PersonGroupMember elements in Level One even though optional in the full schema

To ensure proper identification of primary authors within a person group for Level One compliance

RIXML Level One Addendum v2.5, p.7

primaryIndicator attribute must be set to 'Yes' for ProductFocus in Level One

Level One restricts the cardinality of ProductFocus to one, making all instances primary by definition

RIXML Level One Addendum v2.5, p.21

The primaryIndicator attribute for Region was made required to ensure at least one region is marked as primary when a product has region-level focus

When research products focus on regional analysis, consumers need to identify which regions are the main subject of discussion to properly categorize and route the content

RIXML Research Data Dictionary v2.5.1, p.62

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

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

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

RIXML Research Data Dictionary v2.5.1, p.61

The primaryIndicator attribute should be set to Yes for all elements related to the element identified as the primary entity that a report discusses

This approach allows the Focus tag to identify what type of entity the report is primarily about, while the primaryIndicator clarifies which specific tagging refers to the primary entity versus non-primary entities mentioned in the report

RIXML Research Data Dictionary v2.5.1, p.17

In compilation reports, companies should not have primaryIndicator set to Yes unless there is substantial unique information that would not appear in a separate focused report

This prevents compilation reports from cluttering search results for users looking for primary coverage of specific companies, while allowing for rare cases of unique substantial content

RIXML Research Data Dictionary v2.5.1, p.20

Semantic Relationships

Qualifies2 relationships

ProductFocusSHOULD

The primary indicator setting determines which entities are tagged as primary based on the product focus, enabling distinction between primary discussion topics and entities that are merely mentioned

RIXML Research Data Dictionary v2.5.1, p.17When to set primaryIndicator to "Yes" and when to set it to "No"

PersonGroupSHOULD

PersonGroupMember primaryIndicator identifies which individual member has primary status within a group, allowing multiple primary members per group

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

Requires10 relationships

When focus is set to Issuer, exactly one issuer must be marked with primaryIndicator as Yes, except in rare cases like merger discussions involving two companies

RIXML Research Data Dictionary v2.5.1, p.17When to set primaryIndicator to "Yes" and when to set it to "No"

At least one Resource within a product must have primaryIndicator set to Yes to identify the primary resource

RIXML Research Data Dictionary v2.5.1, p.40primaryIndicator (Required, YesNoEnum)

If ProductFocus is set to Issuer level, then at least one Issuer must be marked as primary with primaryIndicator

RIXML Research Data Dictionary v2.5.1, p.49primaryIndicator (Required, YesNoEnum)

ProductFocusINFORMATIVE

ProductFocus is used in conjunction with primaryIndicator fields in various elements like SectorIndustry to indicate the primary topic of the product

RIXML Research Data Dictionary v2.5.1, p.50ProductFocus

ProductFocusINFORMATIVE

ProductFocus is used in conjunction with primaryIndicator fields in various elements like Issuer to indicate the primary topic of the product

RIXML Research Data Dictionary v2.5.1, p.50ProductFocus

When the product is focused on the Region level with ProductFocus set to Region, then at least one Region must be marked as primary

RIXML Research Data Dictionary v2.5.1, p.62primaryIndicator (Required, YesNoEnum)

When the product is focused on the SectorIndustry level, at least one SectorIndustry must be marked as primary

RIXML Research Data Dictionary v2.5.1, p.64primaryIndicator (Required, YesNoEnum)

When ProductFocus is set to Issuer, at least one Issuer element must have its primaryIndicator attribute set to Yes to identify the main subject of the report

RIXML Implementation Guide v2.5.1, p.23EXAMPLE 1:

For Level One compliance, the Organization primaryIndicator attribute must be present and set to Yes

RIXML Level One Addendum v2.5, p.6Research.Product.Source.Organization

Though the primaryIndicator attribute is optional in the full schema, Level One compliance requires it for PersonGroupMember

RIXML Level One Addendum v2.5, p.7Research.Product.Source.Organization.PersonGroupMember

Implies1 relationship

When an issuer is marked as primary, all related elements describing that issuer such as sector/industry, region, and country should also have their primaryIndicator set to Yes

RIXML Research Data Dictionary v2.5.1, p.17When to set primaryIndicator to "Yes" and when to set it to "No"

Constrains9 relationships

For sector/industry reports, all issuer identifiers should have primaryIndicator set to No while the relevant sector or industry should have primaryIndicator set to Yes

RIXML Research Data Dictionary v2.5.1, p.17Sector/Industry reports

In compilation reports, primary indicator should rarely be set to Yes for any company unless the report contains critical information about that company not available in separate focused reports

RIXML Research Data Dictionary v2.5.1, p.20Compilation Reports

SourceMUST

When multiple organizations collaborate on a product, exactly one must be designated as primary, typically the parent organization or joint venture name

RIXML Research Data Dictionary v2.5.1, p.25Organization

PersonGroupSHOULD

When multiple PersonGroups exist, the primaryIndicator attribute determines which one takes precedence

RIXML Research Data Dictionary v2.5.1, p.28primaryIndicator (Optional, YesNoEnum)

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

At least one country must be marked as primary when product focus is set to Country level

RIXML Research Data Dictionary v2.5.1, p.61primaryIndicator (Required, YesNoEnum)

The focus of the report determines whether certain tags are required, highly recommended, or optional based on the primary subject matter

RIXML Implementation Guide v2.5.1, p.22Identifying report focus is critical

SourceMUST

Only one organization can be marked as primary publisher when contained within the Source element

RIXML Implementation Guide v2.5.1, p.34The corresponding information in the Data Dictionary looks like this:

Level One restricts ProductFocus primaryIndicator to Yes because only one ProductFocus is allowed

RIXML Level One Addendum v2.5, p.21Research.Product.Context.ProductDetails.ProductFocus