Resource
RIXML 2.5 Element
Describes the actual media file containing research content, with required resourceID, primaryIndicator, and language attributes. For Level One, resourceID must be UUID matching researchID and productID.
Describes the resource that contains the media representation of the research product. For example, can describe a file, URL, or encoded data that represents the product. There can be any number of Resource elements associated with a product. For example, a product may consist of both a PDF document (one resource) and an Excel spreadsheet (another resource), or there could be multiple language versions of the same document (each one a resource).
Usage
Required element within Content, appearing exactly once. Must have resourceID (UUID), primaryIndicator='Yes', and language attributes. Contains MIMEType, Name, and optional Length elements.
Business Context
Critical for linking RIXML metadata to actual research documents, enabling content delivery systems to properly identify and serve research files to consumers.
Specification Guide
Overview
Resource represents individual media files, URLs, or encoded data that constitute the actual research content deliverable to consumers. This element serves as the bridge between RIXML metadata and the physical research materials, enabling flexible content delivery through various formats (PDF, Excel, audio) and distribution mechanisms (file references, embedded data, URL links). Each Resource describes a specific piece of content with comprehensive metadata including format specifications, language designation, and access methods.
Usage
Resource is an optional child element of Content with multiple instances allowed per product. At least one Resource with primaryIndicator='Yes' is required when resources are included. Each Resource must have a unique resourceID within the product scope. Use multiple Resources for different formats, language translations, or related materials (e.g., PDF report with supplementary Excel spreadsheet). The element supports three delivery methods: companion files via Name, embedded base64-encoded data via Data, or remote access via URL.
Rules
- MUSTThe resource file name specified in the Resource Name tag must match exactly the name of the actual file sent, including case sensitivity[RIXML Research Data Dictionary v2.5.1 p.11] [Best Practices for Publishing RIXML p.6]
- SHOULDFile names should not be reused unless the file being published is a replacement for a previously published file[RIXML Research Data Dictionary v2.5.1 p.11]
- MUSTAt least one Resource within a Product must have primaryIndicator set to indicate the primary resource[RIXML User Guide v2.1 p.23] [RIXML User Guide v2.3 p.23]
- MUSTResource content must specify MIME type for proper content handling[Morning Call Report (Advanced) Sample v2.4]↗
- MUSTFor Level One compliance, Content must contain exactly one Resource element[RIXML Level One Addendum v2.2 p.14] [RIXML Level One Addendum v2.3 p.9] [RIXML Level One Addendum v2.4 p.9]
- MUSTLevel One supports only payload files, excluding embedded data payloads and remote URL payloads[RIXML Level One Addendum v2.2 p.31] [RIXML Level One Addendum v2.3 p.26] [RIXML Level One Addendum v2.4 p.26] [RIXML Level One Addendum v2.5 p.26]
- MUSTFor Level One compliance, the RIXML instance document filename and payload filename must match except for file extensions[RIXML Level One Addendum v2.2 p.31] [RIXML Level One Addendum v2.3 p.26] [RIXML Level One Addendum v2.4 p.26] [RIXML Level One Addendum v2.5 p.26]
- MUSTWhen multiple resources exist for the same product with the same productID, they must all refer to the same discrete research idea[RIXML Research Suite Data Dictionary v3.0 (DRAFT) p.12]↗
- MUSTResource elements must specify the primary language in which the payload document is written[RIXML Release Notes v2.5 p.24]
Relationships
- child-ofContent — Resource is an optional child of Content, providing the actual media representation of the research product
- constrainsName — Resource Name element value must match the actual payload file name exactly including case sensitivity
- requiresResource.primaryIndicator — At least one Resource must have primaryIndicator set to 'Yes' to designate the primary resource
- requiresResource.resourceID — Each Resource must have a unique resourceID within the product scope for proper identification
- qualified-byPrice — Price element qualifies Resource elements by enabling commercial research distribution and supporting the sale of research content
- containsURL — Resource can contain URL element for remote content access in linkback implementations
- containsData — Resource can contain Data element for embedded base64-encoded content, but not in Level One compliance
Where It Fits
Definition
| Type | |
| Namespace | http://www.rixml.org/2017/9/RIXML |
| Min Occurs | 1 |
| Max Occurs | 1 |
Attributes
resourceIDstring |
The unique identifier of the resource within the product. The implementation of the resourceID is left for the publishers of content to implement as they deem fit. At a minimum, the resourceID is required to be unique within the product(s) it appears under. requiredSince 2.1 |
Indicates the language of the resource, described using the ISO 639-2/T Code. Highly recommended, especially when multiple resources are included that are different translations of the same product. Whereas the language attribute of the Research element represents the language of the metadata describing the Research, the language attribute of the Resource element represents the language of the media representation (often a file) of the product. These two language attributes may be different. optional |
sizeInBytesstring |
Indicates the size of the resource in bytes. Could be used by the end user to estimate the download time and storage needs. optionalSince 2.1 |
primaryIndicatorYesNoEnum |
Indicates the primary Resource. At least one Resource must be set to Primary. required |
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 |
typeResourceTypeEnum |
optional |
Children
Protocolstring0..1 |
Indicates the protocol (rules determining format and transmission). This eliminates the need for parsing this information from the URL. optionalSince 2.1 |
Lengthstring0..1 |
optionalSince 2.1 |
StatusInfo(complex)0..unbounded |
optionalSince 2.1 |
Pricestring0..1 |
optionalSince 2.3 |
MIMETypestring1..1 |
Indicates the type of media used to store the content. MIMEType is used to determine the software product(s) that can read the content. MIMETypes are described in RFC 2046. requiredSince 2.1 |
Namestring0..1 |
The Name element is intended to provide a research consumer with a suggestion on how to store the particular resource, whether is comes via an actual file, embedded data or remote URL. If this RIXML file arrives with a companion file (PDF, Word, text, etc.) representing this resource, then the Name value is used to match the resource with right companion file. If a payload file is embedded data, the Name value is used by the publisher to suggest a file name to the consumer, who may choose to store the embedded data locally. If a payload file is referenced via URL, the Name value is similarly used by the publisher to suggest a file name to the consumer for local storage. optionalSince 2.1 |
Commentsstring0..1 |
Any additional comments that are deemed necessary. For example, which software version is required to open the document? Or, how does this resource relate to the others for this product? optionalSince 2.1 |
URLanyURI0..1 |
Indicates the URL at which the resource can be found. optionalSince 2.1 |
Database64Binary0..1 |
Used when the content (data) of the research product needs to be included within the RIXML document. The data must be base64-encoded. optionalSince 2.1 |
XMLData(complex)0..1 |
optionalSince 2.2 |
Example
<Resource resourceID="f47ac10b-58cc-4372-a567-0e02b2c3d479"
primaryIndicator="Yes">
<MIMEType> ... </MIMEType>
</Resource>Version History
XMLDataPriceThe Resource element has evolved significantly across RIXML versions. In version 2.1, the Data child element type changed from xsd:anyType to xsd:base64Binary for improved binary payload support [RIXML Release Notes v2.1 p.4]. Version 2.2 introduced support for embedded XML content, particularly XBRL instance documents via XMLData, and made resourceID a unique key constraint [RIXML Release Notes v2.2 p.2]. Version 2.3 added Price support to enable commercial research distribution models [Best Practices for Publishing RIXML p.18]. Version 2.4 introduced PhotoResourceIdRef for linking person photographs to resources [RIXML Release Notes v2.4 p.22]. Version 2.5 enhanced globalization support by requiring language tagging on resource payload documents [RIXML Release Notes v2.5 p.24]. Version 3.0 draft restructured resources under ResourceList and introduced ResourceTypeEnum for content typing [RIXML Research Suite Data Dictionary v3.0 (DRAFT) p.18]↗.
Business Rules
The resource file name specified in the Resource Name tag must match exactly the name of the actual file sent, including case sensitivity
The resourceID attribute must be unique within the product context where the Resource element appears
At least one Resource element must have its primaryIndicator attribute set to Primary
The identifiers researchID, productID, and resourceID must share the same UUID value in Level One
All identifiers in Level One must be UUIDs
The RIXML instance document filename and payload filename must match except for file extensions
Resource elements must specify the primary language in which the payload document is written
File names should not be reused unless the file being published is a replacement for a previously published file
The language attribute on Resource element is highly recommended when multiple resources with different translations of the same product are included
Design Decisions
Resource cardinality restricted to exactly one in Level One Content element
To substantially reduce complexity for both publishers and vendors, alleviating implementation costs
RIXML Level One Addendum v2.5, p.25
Only payload files are supported in Level One Resource elements
To reduce complexity by eliminating embedded data payloads and remote URL payloads
RIXML Level One Addendum v2.5, p.26
Added type attribute as a companion to the XMLData element using ResourceTypeEnum
To provide a code as a clue to the kind of XML data that can be expected, with XBRL code indicating XMLData can be read as XBRL content
RIXML Research Data Dictionary v2.5.1, p.40
Semantic Relationships
Contrasts With3 relationships
The language attribute on Research indicates the language of the metadata tagging, while Resource language indicates the language of the actual content payload which may differ
RIXML Research Data Dictionary v2.5.1, p.18— Language
Resource language attribute represents the language of the media content while Research language attribute represents the language of the metadata describing the research
RIXML Research Data Dictionary v2.5.1, p.39— language (Optional, String)
The UUID for personID will not be the same as the one used for resourceID
RIXML Level One Addendum v2.5, p.8— Research.Product.Source.Organization.PersonGroupMember.Person
Requires4 relationships
PhotoResourceIdRef must reference a valid Resource.resourceID within the same Product to establish the photograph link
RIXML Research Data Dictionary v2.5.1, p.32— PhotoResourceIdRef (Optional, String)
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.40— primaryIndicator (Required, YesNoEnum)
Resource link identifier reference must match a valid resource identifier attribute to establish proper linkage
RIXML Research Data Dictionary v2.5.1, p.54— Elements and Attributes
Level One requires productID and resourceID to share the same UUID value
RIXML Level One Addendum v2.5, p.25— Identifiers
Qualifies2 relationships
The type attribute serves as a companion to XMLData element providing a code clue about the kind of XML data contained
RIXML Research Data Dictionary v2.5.1, p.40— type (Optional, ResourceTypeEnum)
Resource payload documents are tagged with their primary written language to support multilingual content delivery
RIXML Release Notes v2.5, p.24— Toward improved globalization
Blocks Action4 relationships
TagsUpdated status indicates no payload file transmission is expected, preventing unnecessary resource transfers
RIXML Research Data Dictionary v2.5.1, p.124— TagsUpdated
Level One does not support embedded data payloads in Resource elements
RIXML Level One Addendum v2.5, p.26— Payloads
Level One does not support remote URL payloads in Resource elements
RIXML Level One Addendum v2.5, p.26— Payloads
When tags are updated without payload changes, this status prevents unnecessary re-transmission of large payload files
RIXML Release Notes v2.5, p.6— When only the tags are changed, not the payload
Evidences1 relationship
Resource element provides reference to the actual research report, whether as PDF, audio file, or other media format that contains the research content
RIXML Implementation Guide v2.5.1, p.17— Level One
Constrains2 relationships
For Level One compliance, the productID should match the resourceID value
RIXML Level One Addendum v2.5, p.6— Research
While optional in the full schema, the Name element is required for Level One compliance
RIXML Level One Addendum v2.5, p.11— Research.Product.Content.Resource.Name