DDEX Standard

Skip to end of metadata
Go to start of metadata

This section of the DDEX Knowledge Base contains the UGC Profile for the Digital Sales Reporting Message Suite Standard (Version 1.3 of Part 4)

1  Introduction

This standard was developed by the member organisations of the Digital Data Exchange, LLC (DDEX) and provides a message that gives a uniform mechanism to enable Licensees (typically Digital Service Providers) to report to Rights Controllers (typically Music Rights Societies, Music Publishers, Music Licensing Companies and/or Record Companies) information regarding the level of usage and/or revenue generated from the distribution of such products, as well as sales of products based on Releases, to the relevant Rights Controllers.

The Flat File Variant of the Digital Sales Reporting Message Suite Standard has been developed in response to concerns regarding the file size and computational complexity of the XML Variant, and will lead to reduced implementation and running cost for Licensees and Licensors for user-generated content where the Message Sender either has, or has not, received a claim for a sound recording from the owner of that sound recording (the “master” Recording).

Any organisation wishing to implement this (or any other DDEX standard) is required to apply for an Implementation Licence. The terms of the licence and an application form can be found on https://ddex.net/implementation/implementation-licence-and-ddex-party-identifiers.

 

 

Essential Reading

Download/Print standard (PDF)

This standard is Part 4 of a multi-part standard. The other parts (incl. samples) are available here.

Older versions of the various parts of the DSR standard can be accessed here.

Samples for the current version of the DSR Standard can be found here.

2 Scope

 2.1 Introduction

The message defined in this Part provides a mechanism for Licensees (typically Digital Service Providers) to report to Rights Controllers (typically Music Rights Societies, Music Licensing Companies, Music Publishers and/or Record Companies) User-Generated Content (UGC) Usages, Revenues or Sales.

 2.2 Organisation of the Standard

This standard comprises six clauses and one annex. Clauses 1-4 provide the scope, abbreviations and core definitions used in this standard. Clause 5  then defines the UGC profile.

Finally Annexes A provides some examples.

 2.3 Release Notes (Informative)

Version 3 of the Flat File Variant of the Digital Sales Reporting Message Suite Standard utilities a fundamentally different architecture than Version 2. This new architecture allows more Profiles to be supported than was possible in Version 2. Part 4 of this standard supports communicating sales and usages for UGC services.

Version 1.1 of the UGC Profile provides a series of minor updates to some record types and replaces the use of SY03 with SY04 and SY05.

Version 1.1.1 of the UGC Profile corrects a bug in the LI01 record.

Version 1.2 of the UGC Profile makes use of updated SY04, SY05, AS01, AS02, MW01, SU03 and LI01 records that support additional business requirements.

Version 1.3 (this version) incorporates the Single Record Block Variant into this standard and harmonises the Multiple and Single Record Block Variants.

 

Below is the list of changes made to the UGC Profile's Record Types over time:

Record Types1.21.3

SY02

.02

.03

SY04

.01

.02

SY05

.02

.03

SY09

Base Record

.01

AS01

.01

.02

AS02

.02

.03

MW01

.01

.02

LC01

Not used

Base Record

RU01

.01

.02

RU02

.01

.02

SU03

.02

.02

ST01

Not used

Base Record

LI01

.02

.03

SR03

Base Record

.01

SR06

Base Record

.01

 

 

 


3 Normative References

 Click here to expand...

The following normative documents contain provisions, which through reference in this text constitute provisions of this standard. For dated references, subsequent amendments to, or revisions of, any of these publications do not apply. For undated references, the latest version applies.

  • DDEX. Digital Sales Reporting Message Suite Standard - Part 1: Architecture of the Flat File Variant.
  • DDEX. Digital Sales Reporting Message Suite Standard - Part 2: Allowed Value Sets.
  • DDEX. Digital Sales Reporting Message Suite Standard - Part 8: Record Type Definitions.

4 Terms and Abbreviations

 Click here to expand...

The terms and abbreviations used in Digital Sales Reporting Message Suite Standard – Part 1: Architecture of the Flat File Variant. also apply to this Standard.

5 UGC profile

 5.1 Introduction

This Profile is for reporting all Usage, Revenue or Sales for user-generated content where the Message Sender has received a claim for a sound recording from the owner of that sound recording (the “master” Recording). The Message Sender may or may not include information specific to the Licensors or RightsController of the Musical Works. 

To indicate that a Sales/Usage Report is created in accordance with Clause 5.2 of this Profile standard, the Profile Cell in the HEAD Record shall contain the value UGCProfile and the ProfileVersion Cell shall contain the value 1.3.

To indicate that a Sales/Usage Report is created in accordance with Clauses 5.3 or 5.4 of this Profile standard, the Profile Cell in the HEAD Record shall contain the value UGCProfileSRB and the ProfileVersion Cell shall contain the value 1.3.

 5.2 Multi Record Block Variant of this Profile

The following Records shall be communicated for each Block in this order:
  1. One Resource Record of type AS02.03 describing the Resource including basic information of the underlying Work (the Work part of this data shall be included as provided by the record company to the Licensee).
    The Message Sender may wish to split the information into multiple Records instead of using one AS02.03 Record:
    1. The first Record, of type AS01.02, contains information regarding the Sound Recordings, Videos and other “master” Resources that have been used in creating the user-generated content that has been accessed;
    2. The following none, one or more Musical Work Record(s), of type MW01.02 contain information about the Musical Work(s) utilised as provided by the record company to the Licensee. If the Resource contains more than one Work, the Work shall be communicated in multiple Blocks so that only one Work is reported in a Block).

  2. None, one or more Records providing data about the same Resource/Work described in the above AS/MW Records. However, these LC01 Records provide the information a received, by the Licensee, from the Record Company or Aggregator listed in the DataProvider Cell. The LC01 Records are optional as bi-laterally agreed between Licensee and Licensor.

  3. None, one or more UGC Release Usage Records of type RU01.02 describing the use of UGC Releases.
    Instead of a RU01.02 record, the Message Sender may use one RU02.02 Record for each UGC Release and its use.
    It is not permissible to communicate RU01.02 and RU02.02 Records in one Block.
    The Block shall contain multiple RUxx Records for each ASxx Record in that one RU01.02 Record shall be provided for each ContentCategory; one RU02.02 Record shall be provided for each UGC Release.

  4. One or more UGC Sales/Usage Record of type SU03.02 Record followed by
    1. None, one or more Licensor-specific Usage Data Record of type LI01.03 providing Licensor-specific information for the usages reported in the preceding SU03.02.
    2. Each of the LI01.03 records followed by none or one MW01.02 Record to indicate Licensor-specific Work information. These Records shall contain the Work information provided to the DSP by the RightsContoller referenced in the preceding LI01.03 Record.

All records, unless specifically indicated, shall represent the data as used by the Licensee for its own processes.

The Blocks shall be preceded by one or more Summary Records SY02.03, SY04.02, SY05.03 or SY09.01 for each type of use, commercial model and territory any Release contained in the Sales Report Message has been traded under. In cases where a Message Sender provides information at RightsController level, the fields at RightsController level in SY02.03 or SY04.02/SY05.03 and LI01.03 records can be provided.

When using SY04.02, all SY04.02 Records for the same RightsType and sales context (as defined in Clause 6.5 of Part 1 of this standard) may carry the same SummaryRecordId if per-subscriber minima information needs communicating per context, but across different subscriber types. Each SY05.03 records shall be followed by 1-n groupings of 1 SY09.01 Record, followed by 1-n SY05.03 Records:

  • 0-n SY04.02 

    • 1-n SY09.01

      • 1-n SY05.03

It is recommended to provide the Summary Records in a logical order to aid human readability. This would typically mean that Summary Records of different types are not mixed. For example a sequence of SY02.03 SY02.03  SY04.02 SY04.02 meets this recommendation, whereas SY02.04 SY02.03 SY04.02 does not.

 

The figure shows two ways in which this Profile can be implemented. The left-hand diagram shows the case where Musical Work information is provided as part of the Resource Record (AS02.03) and only a usage summary Record is RU01.02 is provided and the right-hand diagram shows the case where Musical Work information is provided on an extra MW01.02Record and usage information is provided in multiple RU02.02 Records. For the avoidance of doubt, it is also possible to use AS02.03 Records together with RU02.02 Records as well as AS01.02/MW01.02 with RU01.02.

The table below provides an overview of the order and cardinality of the Records to be used in this Profile.

 

RecordType

Cardinality 

Comment

HEAD

1

 

SY02.03 or SY04.02/SY09.01/SY05.03

1-n

A combination of the four Summary record types is allowed:

  • First all SY02.03 Records (if there are any),

  • Then all SY04.02/SY09.01/SY05.03 Records as follows: Each SY02/04 shall be followed by 1-n sequences of 1 SY09.01Records immediately followed by 1-n SY05.02 Records.

Block

0-n

 

|   AS01.02 or AS02.03

1-n

Note: DDEX is working on rules on how to populate these AS01.02 and AS02.03 as well as the WM01.02 Records directly below, and intends to publish these rules at a later stage.

|   |   MW01.02

0-n

May only follow an AS01.02 record. If the AS01.02 contains more than one Musical Work, multiple Blocks must be provided, one for each Musical Work. 

These AS01.02 and MW01.02 Records shall contain the Work information provided to the Licensee by the record company.

|   |   LC01

0-n

Provides additional information about the Resource/Work described in the preceding AS/MW as received by the Licensee from the Record Company or Aggregator listed in the DataProvider Cell.

|  |  RU01.02 or RU02.02

0-n

One RU01.02 Record shall be provided for each ContentCategory .

One RU02.02 Record shall be provided for each UGC Release.

|   |  SU03.02 

1-n

The SU03.02 record points to a SY02.03 or SY02/04 and SY05.03 Record, but only if there is no LI01.03 Record following. In that case the relevant SYxx Record provides non-Licensor specific summary information.

This record will point to an RUxx Record for the relevant ContentCategory as well as the SYxx Record without a specific Rights Controller.

|   |   |   ST01

0-n

The ST01 Records can be used to communicate usages reported in the preceding SU03.02 broken down by SubscriberTyp.

If an ST01 Record is included in a sales/usage report, its data will be summarised in a SY04 Summary Record. 

|   |   |   LI01.03 

0-n

One LI01.03 for each RightsController (if provided).

|   |   |   |   MW01.02

0-1

This MW01.02 Record is intended to contain Musical Work information relative to the Rights Controller in the preceding LI01.03 Record.

This/these instance of MW01.02 shall contain the Work information provided to the Licensee by the RightsContoller referenced in the preceding LI01.03 Record.

If MW01.02 Records are provided for multiple LI01.03 Records within an Intra-Block Grouping, it is possible that the MW01.02 Records contain the same data. 

FOOT

1

 

 

 

For cases where the Message Sender has not received a claim for a sound recording from its owner, the AS01.02/AS02.03  record shall be virtually empty, only containing a RecordType and a BlockId.

 5.3 Default Single Record Block Variant of this Profile

The table below provides an overview of the order and cardinality of the Records to be used in this Variant.

 

Record Type

Card.

Comment

HEAD

1

 

SY02.03 or SY04.02/SY05.03

1-n

Also a combination of the four Summary record types is allowed:

  • First, all SY02.03 Records (if there are any),

  • Then, all SY04.02/SY05.03 Records as follows: each SY04.02 shall be followed by 1-n SY05.03 Records.

SR03.01

0-n

The SR03.01 Record Type has been derived from the Record Types used in the Multi-Record Block Variant of the UGC Profile

SRFO

1

This footer record differs from the one used in the other Variants.

 5.4 Single Record Block Variant of this Profile for Ad-supported and Subscription Models

The table below provides an overview of the order and cardinality of the Records to be used in this Variant.

 

Record Type

Card.

Comment

HEAD

1

 

SY01.02 or  SY02.03 or  SY04.02/SY05.03 

1-n

Also a combination of the three Summary record types is allowed:

  • first, all SY01.02 Records (if there are any),

  • then, all SY02.03 Records (if there are any),

  • then, all SY04.02/SY05.03 Records (if there are any)

SR06.01

0-n

The SR06.01 Record Type has been derived from the Record Types used in the Multi-Record Block Variant of the Basic Audio Profile.

SRFO

1

This footer record differs from the one used in the other Variants.

 5.5 Rules for Populating AS01, AS02 and MW01 Records

Unable to render {include} The included page could not be found.

 

Annex A (informative) Examples

 Click here to expand...

Published alongside this standard are a series of Examples in the form of an Excel workbook. To transform them into Sales Report messages in accordance with this standard, the individual tabs of the spreadsheet can be saved as a tab-delimited file

Evaluation Licence for DDEX Standards

 

Subject to your compliance with the terms and conditions of this Agreement, DDEX™ grants you a limited, nonexclusive, non-transferable, non-sublicenseable, royalty-free licence solely to reproduce, distribute within your organisation, and use the DDEX standard specifications (“DDEX Standards”) solely for the purpose of your internal evaluation. You may not make any commercial use of the DDEX Standards under this agreement. No other licences are granted under this agreement.

No representations or warranties (either express or implied) are made or offered by DDEX with regard to the DDEX Standards. In particular, but without limitation, no representations or warranties are made in relation to:

  1. The suitability or fitness of the standards for any particular purpose;
  2. The merchantability of the standards;
  3. The accuracy, completeness, relevance or validity of the standards; or
  4. The non-infringement of any third party intellectual property rights related to the DDEX Standards.

Accordingly, DDEX and/or its members shall not be liable for any direct, indirect, special, consequential or punitive loss or damages howsoever arising out of or in connection with the use of the standards. IN THE EVENT THAT ANY COURT OF COMPETENT JURISDICTION RENDERS JUDGEMENT AGAINST DDEX AND/OR ITS MEMBERS NOTWITHSTANDING THE ABOVE LIMITATION, THE AGGREGATE LIABILITY TO YOU IN CONNECTION WITH THIS AGREEMENT SHALL IN NO EVENT EXCEED THE AMOUNT OF ONE HUNDRED U.S. DOLLARS (US$ 100.00).

Users of the DDEX Standards are cautioned that it is subject to revision. Users are recommended to use the latest versions, which are available at http://www.ddex.net. The use of outdated versions of the standards is not recommended but may be required by agreement between implementers in particular cases.