DDEX Standard

Skip to end of metadata
Go to start of metadata

This section of the DDEX Knowledge Base contains the Audio-Visual Profile for the Digital Sales Reporting Message Suite Standard (Version 1.2)

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 reporting and/or usages of audio-only usages, revenues or sales that are not addressed by any other Profile of version 3.0 of the Flat File Variant. This Profile is also for reporting usages, revenues or sales for music videos and Resources for which no Release information is available.

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 5 of a multi-part standard. The other parts (including 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 standard provides a mechanism for Licensees (typically Digital Service Providers) to report to Rights Controllers (typically Music Rights Societies, audio-visual rights societies, Music Licensing Companies, Music Publishers and/or Record Companies) Usage, Revenue or Sales from the exploitation of Products based on electronic Releases containing Audio-Visual Recordings which may embody Musical Works, non-musical Works and/or other Resources and/or for which Cues are being provided.

 2.2 Organisation of the Standard

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

Finally, Annexes A provides some examples.

 2.3 Release Notes (Informative)

Version 1.1 of the audio-visual Profile makes use of an updated RE03 record that allows the communication of date of the first video on demand broadcast of a Resource.

Version 1.2 (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 Audio-visual Profile's Record Types over time:

Record Type

1.1

1.2

SY02

.02

.03

SY04

.01

.02

SY05

.02

.03

SY06

.01

.02

RE03

.01

.01

RE02

Base Record

Base Record

AS03

.01

.02

AS04New Record Type 

CU01

.01

.02

CU02

Not used

Base Record

SU01

Base Record

.02

SU02

Base Record

Base Record

SU03

.02

.03

SU04

.01

.02

SU05New Record Type 

SR04

Base Record

.01

SR05

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 Audio-visual Profile

 5.1 Introduction

This Profile is for reporting all sales and usages of audio-visual Recordings (excluding music videos).

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

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

 5.2 Definition of Blocks where Release Information is Available

When Usages, Revenues or Sales are to be reported where Release information is available to the Message Sender, the following Records shall be communicated for each Block in this order:

 

  1. One Release Record of type RE03.02 describing an audio-visual Head Release.
    If the Message Sender has received a NewReleaseMessage defined in DDEX’s Release Notification Message Suite Standard, the “Head Release” is the AlbumRelease as defined in the NewReleaseMessage.

  2. One or more Resource Records describing Resources of type AS03.02.
    These Records provide information regarding all the Videos that are contained in the Head Release.

  3. None, one or many Cue Records of type CU01.01.
    Cue Records allow the identification and description of cues, i.e. information about Musical Works or Resources that have been used in a specific Resource and how they have been used. As shown below, the Cue Records are interspersed with the Resource Records. The Cue record immediately following a Resource records are Cues for that Resource

  4. None, one or many Cue Records of type CU02.
    Cue Records allow the identification and description of cues, i.e. information about Musical Works or Resources that have been used in a specific Resource and how they have been used. As shown below, the Cue Records are interspersed with the Resource Records. The Cue record immediately following a Resource records are Cues for that Resource
     
  5. None, one or more Records describing “Sub-Releases” of type RE02.
    These Sub-Releases are either single-Resource Track Releases (as communicated in a NewReleaseMessage) and/or Releases that the Message Sender has generated exclusively from the Resources that are used in the Head Release. The Sub-Release Records shall point to the Resources they make use of. Only Sub-Releases that have been used or sold shall be included in this section of the Block.
     
  6. One or more Records providing Usage, Revenue or Sales figures of type SU01.02 SU02.02, SU03.03, SU04.02 or SU06.
    The SUxx Records shall point to the Release Record to which the Usage, Revenue or Sale transaction relates.

 

The Blocks shall be preceded by one or more Summary Record SY02.03, SY04.02, SY05.03 or SY06.02 for each Rights Controller to whom the Sales Report Message is addressed, to provide information on Usage, Revenue or Sales allocated to that Rights Controller according to the calculations made by the Message Sender.

It is permissible to communicate different types of Summary Records in a single sales/usage report.

When using SY04.01, all SY04.01 records for the same RightsType and sales context (as defined in Clause 6.5 Part 1 of this standard) may carry the same SummaryRecordId if subscriber minima information needs communicating per context, but across different subscriber types.

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 SY06.02 SY06.02 SY06.02 meets this recommendation, whereas SY06.02 SY02.03 SY06.02 does not.

 

Note that in the diagram the first SUxx Record provides Usages, Revenues or Sales for a Sub Release, the second SUxx Record provides Usages, Revenues or Sales for the Head Release.

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

 

Record Type

Cardinality

Comment

HEAD

1

 

SY02.03 or SY04.02 or SY05.03 or SY06.02

1-n

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

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

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

  • then all SY06.02 Records (if there are any).

Block

0-n

 

|   RE03.02

1

 

|   |   AS03.02

1-n

 

|   |   |   CU01.01

0-n

 

|   |   |   CU020-n 

|   RE02

0-n

 

|   SU01.02 or SU02.02 or SU03.03 or SU04.02 ot SU06

1- n

 

FOOT

1

 

 5.3 Definition of Blocks where Release Information is not Available

When Usages, Revenues or Sales are to be reported for Resources for which no information on the Release it is contained in has been previously made available, the following Records shall be communicated for each Block in this order:
  1. One Resource Record describing Resources of type AS03.02 or AS04
    These Records provide information regarding all the Videos that are contained in the Head Release.

  2. None, one or many Cue Records of type CU01.01
    Cue Records allow the identification and description of cues, i.e. information about Musical Works or Resources that have been used in a specific Resource and how they have been used. As shown below, the Cue Records are interspersed with the Resource Records. The Cue record immediately following a Resource records are Cues for that Resource
     
  3. None, one or many Cue Records of type CU02.
    Cue Records allow the identification and description of cues, i.e. information about Musical Works or Resources that have been used in a specific Resource and how they have been used. As shown below, the Cue Records are interspersed with the Resource Records. The Cue record immediately following a Resource records are Cues for that Resource

  4. One or more Records providing Usage, Revenue or Sales figures of type SU01.02, SU02.02, SU03.03, SU04.02 or SU06.
    The SUxx Record does not need to point to the Resource Record to which the Usage, Revenue or Sale transaction relates as this is implicit as the Block only contains one Resource Record.

The Blocks shall be preceded by one or more Summary Record SY01.02, SY02.03, SY04.02, SY05.02 or SY06.02 for each Rights Controller to whom the Sales Report Message is addressed, to provide information on Usage, Revenue or Sales allocated to that Rights Controller according to the calculations made by the Message Sender.

It is permissible to communicate different types of Summary Records in a single sales/usage report.

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 SY06.02 SY06.02 SY06.02 meets this recommendation, whereas SY06.02 SY02.03 SY06.02 does not.

The figure below shows the case where no Musical Work information is provided (left) and the case where Musical Work information is provided in a cue.


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

 

Record Type

Cardinality

Comment

HEAD

1

 

SY02.03 or SY04.02 or SY05.03 or SY06.02

1-n

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

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

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

  • then all SY06.02 Records (if there are any).

Block

0-n

 

|  AS03.02 or AS04

1

 

|  |  CU01.01

0-n

 

|  |  CU02

0-n

 

|  SU01.02 or SU02.02 or SU03.03 or SU04.02 or SU06

1-n

 

FOOT

1

 

 5.4 Single Record Block Variant of this Profile for Download Use Cases

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 or  SY05.03 or SY06.02

1-n

A combination of the 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 (if there are any), 

  • then SY05.03 Records (if there are any).

  • then, all SY06.02 Records (if there are any).

SR04.01

0-n

 

SRFO

1

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

 5.5 Single Record Block Variant of this Profile for Streaming Use Cases

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 or  

SY05.03 or

SY06.02

1-n

A combination of the 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 (if there are any),

  • then SY05.03 Records (if there are any).

  • then, all SY06.02 Records (if there are any).

SR05.01

0-n

 

SRFO

1

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

 

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.