THIS VERSION IS NOT THE LATEST RELEVANT DDEX STANDARD. DDEX RECOMMENDS TO USE THE LATEST VERSION

Skip to end of metadata
Go to start of metadata
 

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.

This Profile of version 3.0 of the Flat File Variant 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 http://ddex.net/implementing-ddex-standards.


Downloads & Older Versions

Download/Print standard (PDF)

This standard is Part 3 of a multi-part standard. The other Parts are available  here.

 

 

2 Scope

 2.1 Introduction
The message defined in this standard provides a mechanism for Licensees (typically Digital Service Providers, including Mobile Service Providers and Internet Service Providers, ISPs) to report to Rights Controllers (typically Music 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 Sound Recordings and/or Music Audio-Visual Recordings which embody Musical Works and/or other Resources.

The Flat File Variant is intended to provide a format for reporting information about the level of usage, revenue or sales generated from the exploitation of Releases and Resources for companies that do not wish to handle XML-formatted sales/usage reports.

Version 3.0 of the Flat File Variant if the Digital Sales Reporting Message Suite Standard is provided in several standards. One standards defines the underlying architecture which is then employed by a series of profile standards. This standard defines one of these profiles.

 2.2 Organisation of the Standard
This standard comprises six clauses and two annexes. Clauses 1-4 provide the scope, abbreviations and core definitions used in this standard. Clauses 5 and 6 then defines the core audio profile and the Record Types that are used by this 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.

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.

4 Terms and Abbreviations

 Click here to expand...

5 Basic Audio Profile

 5.1 Introduction
This Profile is for reporting all audio-only Usage, Revenue or Sales not listed elsewhere in this standard. This Profile is also for reporting Usage, Revenue or Sales for music videos.

To indicate that a Sales/Usage Report is created in accordance with this Profile standard, the Profile Cell in the HEAD Record shall contain the value Basic Audio Profile and the ProfileVersion Cell shall contain the value 1.0.

 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 RE01 describing a 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 AS01 or AS02.


    These Records provide information regarding all the Sound Recordings, Videos and other Resources that are contained in the Head Release.
    While the AS02 Record allows the communication of the basic details of a Musical Work that underpins the Resource, the AS01 Record does not allow this. Only Resources that have been used or sold shall be included in this section of the Block. For the avoidance of doubt, if a Head Release has been used or sold, all Resources of that Head Release need to be included in the Sales Report Message.

  3. None, one or more Musical Work Records of type MW01 describing Musical Works.

    These Records provide information regarding all the Musical Works that are utilised in the Head Release and/or one of its Resources. As shown in Figure 5, the Musical Work Records are interspersed with the Resource Records. The Musical Work records immediately following a Resource record describe Works used in that Resource. MW01 Records may not be used in combination with AS02 Records.
    For the avoidance of doubt: AS01+MW01 and AS02 records may be used within a single Block. One example would be where a DSP communicates, the writers of ten tracks as communicated by the licensee to a works licensor or Rights Conroller but where the eleventh track is a medley created by the DSP comprising multiple Musical Works.

  4. 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 and/or Musical Works 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.

     

  5.  One or more Records providing Usage, Revenue or Sales figures of type SU01 or SU02.

    The SU01/02 Records shall point to the Release Record to which the Usage, Revenue or Sale transaction relates. It is not permitted to reference a Resource or Musical Work Record.

     

The Blocks shall be preceded by one or more Summary Records SY01 , SY02 or SY03 (depending on the commercial model) for each type of use, commercial model and territory any Release contained in the Sales Report Message has been traded under. 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 SY01 SY01 SY03 SY02 SY02 meets this recommendation, whereas SY03 SY01 SY03 does not.

 

Figure 5 shows a Block providing a Head Release with four Resources, three of which include Musical Work information in the Resource Record, whereas one Resource is augmented by Musical Work information in an MW01 Record. Usage, Revenue or Sales are reported for two Sub-Releases as well as for the Head Release.

 

Figure 5 – One Block [1]   of Records when reporting Usages, Revenues or Sales for Audio Releases  [2]

Note that in the diagram the first SUxx Record provides Usages, Revenues or Sales for a Sub Release, the second Record provides Usages, Revenues or Sales for a Resource and the last 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 TypeCardinalityComment
HEAD1 
SY01 or SY02 or SY03
1-nAlso a combination of the three Summary record types is allowed:
first all SY01 Records (if there are any), then all SY02 Records (if there are any), then all SY03 Records (if there are any)
Block0-n 
   RE011 
   AS01 or AS021-n If no musical work information is available, an AS02 Record
should be used with the the relevant Cells left empty.

        MW011-n

May only follow an AS01 record.

   RE020-n 
   SU01 or SU021- n 
FOOT1 

 

 

 


[1] The term Block is used in accordance with Clause 4 .
[2]
The indentation in the diagrams is solely for illustration purposes. There is no indentation in a Sales Report Message in accordance with this standard.


 

 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 Record of type AS02 describing the Resource including basic information of the underlying Work.
    The Message Sender may wish to split the information into two Records. The first Record, of type AS01, contains information regarding the Sound Recording, Video or other Resource, and the second Record, of type MW01, contains information about the Musical Work utilised.

  2.  One or more Records providing Usage, Revenue or Sales figures of type SU01 or SU02.
    The SU01/SU02 Records shall point to the Resource Record to which the Usage, Revenue or Sale transaction relates.

The Blocks shall be preceded by one or more Summary Records SY01, SY02 or SY03 (depending on the commercial model) for each type of use, commercial model and territory any Resource contained in the Sales Report Message has been traded under. 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 SY01 SY01 SY03 SY02 SY02 meets this recommendation, whereas SY03 SY01 SY03 does not.

 

The left-hand part of the Figure 6 below shows the case where Musical Work information is provided as part of the Resource Record AS02 and the right-hand part shows the case where Musical Work information is provided on an extra Record MW01.

Figure 6 – Two Blocks of Records when Reporting Usages, Revenues or Sales for Audio Resources

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

Record TypeCardinalityComment
HEAD1 
SY01 or SY02 or SY03
1-nAlso a combination of the three Summary record types is allowed:
first all SY01 Records (if there are any), then all SY02 Records(if there are any), then all SY03 Records (if there are any)
Block0-n 
   AS01 or AS021 
        MW010-nMay only follow an AS01 record
   SU01 or SU021-n 
FOOT1 


 5.4 Different Types of Usages, Revenues or Sales
This standard defines several Records to describe different types of Usages, Revenues or Sales.

Table 3 – Records for Different Types of Usages, Revenues or Sales

Commercial-
Model-
UseType                   Type

Advertisement-
SupportedModel

PayAsYouGo
Model

Subscription
Model

ContentInfluencedStream

SU02

SU02

SU02

Download

SU01

SU01

SU01

OnDemandStream

SU02

SU02

SU02

Permanent Download

SU01

SU01

SU01

Stream

SU02

SU02

SU02

Tethered Download

SU02

SU02

SU02

TimeInfluencedStream

SU02

SU02

SU02

UseAsRingbacktone

SU01

SU01

SU01

UseAsRingbacktune

SU01

SU01

SU01

UseAsRingtone

SU01

SU01

SU01

UseAsRingtune

SU01

SU01

SU01

Webcast

SU02

SU02

SU02

6 Record Types

 6.1 Introduction
This Clause defines all Record Types that can be communicated within a Sales Report Message formatted in accordance with this standard. Each Flat File Sales Report Message will contain a series of Records, depending on the Profile used.

Table 4 – Header and Footer Record Types

Record Type

Description

HEAD

Global Header Record for all Sales Report Message formatted in accordance with this standard. This Record Type is defined in the  Digital Sales Reporting Message Suite Standard (Version 3.0) - Architecture of the Flat File Variant.

FOOT

Global Footer Record for all Sales Report Message formatted in accordance with this standard. This Record Type is defined in the  Digital Sales Reporting Message Suite Standard (Version 3.0) - Architecture of the Flat File Variant.

Table 5 – Summary Record Types

Record Type

Description

SY01

 Summary Record for Usage, Revenue or Sales of Audio Releases or Resources for the PayAsYouGoModel

SY02Summary Record for Usage, Revenue or Sales of Audio Releases or Resources for Ad-Supported and Interactive Streaming Services
SY03Summary Record for Usage, Revenue or Sales of Audio Releases or Resources for Subscription Services

Table 6 – Release Record Types

Record Type

Description

RE01

Basic Audio Release Record to describe audio Releases that have been used or sold

RE02

Basic Sub-Release Record to describe Sub-Releases that have been used or sold

 

Table 7 – Resource Record Types

Record Type

Description

AS01

Basic Sound Recording Record to describe sound recordings and music videos that have been used or sold individually or as part of a Release (without Musical Work Information)

AS02

Basic Sound Recording Record to describe sound recordings and music videos that have been used or sold individually or as part of a Release (with Musical Work Information)

 

Table 8 – Work and Cue Record Types

Record Type

Description

MW01

Basic Record to describe a Musical Work that has been utilised

 

Table 9 – Record Types to describe Usages, Revenues or Sales

Record Type

Description

SU01

Usage, Revenue or Sales Record for Download Services

SU02

Usage, Revenue or Sales Record for Streaming Services and Webcasts

 6.2 Summary Records
 6.2.1 SY01 – Basic Summary Record

 6.3.1.1 Purpose of Record

This is the Record to communicate basic summary information about Usages, Sales and Revenues.

6.3.1.2 Definition of Cells

Cell NameField DefinitionData TypeM/O/C?Example
RecordType

The Type of the Record; always to contain “SY01”.

Fixed stringMSY01
SummaryRecordId
The Identifier (specific to the Message) of the Summary Record. This Identifier shall be used by Usage/Revenu e/Sales Records to indicate to which Summary Record they provide details.
StringM34
DistributionChannelThe Licensee on whose behalf the Sales/Usage has been generated.StringCMyCo
DistributionChannelDPIDThe DDEX Party ID of the DistributionChannel.DPIDCDPIDA12345SDF
CommercialModel

TheType of CommercialModel of the SalesTransaction. The CommercialModel  indicates how a Consumer pays for a Service or Release.

AVS PayAsYouGoModel
UseType

The nature of a Service, or a Release, as used by a Consumer.

AVSMPermanentDownload
Territory

The Territory for which the sale/transaction is reported.

AVSMDE
ServiceDescriptionThe service name (e.g. a service tier) under which the SalesTransaction took place. The ServiceDescription may not contain space characters or underscores.
StringMPremium Service
Usages

The number of Usages of the Release or Resource from the MessageSender to Consumers, including any sales adjustments. Sales adjustments include e.g. file failures.

For the avoidance of doubt: this Cell shall contain all relevant Usages of Releases plus all relevant Usages of Resources.

IntegerM123554
Subscribers

The number of subscribers to a Service 

FloatC12345
Currency

The Currency in which the DspNetRevenue and IndirectNetRevenue are provided (represented by an ISO 4217 CurrencyCode

AVSMCAD
NetRevenue

Net Revenue of the DSP generated from the distribution of such products, as well as sales of products based on Releases embodying relevant Work(s).

FloatM223345.12
IndirectNetRevenue

Net Revenue of the MessageSender that was generated and that cannot be allocated to individual Releases. This field is Contractually Mandatory.

FloatC13424.50

6.3.1.3 Definition of Conditions

Subscribers shall only be provided when the service is based on subscriptions. IndirectNetRevenue shall only be provided when indirect revenues were generated.

 6.2.2 SY02 – Summary Record for Ad-Supported and Interactive Streaming Services

6.2.2.1 Purpose of Record

This Record can be used to communicate summary information about Usages, Sales and Revenues with support for ad supported and interactive streaming services.

6.2.2.2 Definition of Cells

Cell NameField DefinitionData TypeM/O/C?Example

RecordType

The Type of the Record; always to contain “SY02”

Fixed String

M

SY02

SummaryRecordIdThe Identifier (specific to the Message) of the Summary Record. This Identifier shall be used by Usage/Revenue/Sales Records to indicate to which Summary Record they provide details.StringM34
DistributionChannelThe Licensee on whose behalf the Sales/Usage has been generated.StringCMyCo
DistributionChannelDPID

The DDEX Party ID of the DistributionChannel.

DPIDCDPIDA12345SDF

CommercialModel

The Type of CommercialModel of the SalesTransaction. The CommercialModel  indicates how a Consumer pays for a Service or Release.

AVS

M

AdvertisementSupportedMode

UseType

The nature of a Service, or a Release, as used by a Consumer.

AVS

M

Stream

Territory

The Territory for which the sale/transaction is reported.

AVS

M

FR

ServiceDescription

The service name (e.g. a service tier) under which the SalesTransaction took place.  The ServiceDescription may not contain space characters or underscores.

String

M

Premium Service

Usages

The number of Usages of the Release or Resource from the MessageSender to Consumers, including any sales adjustments. Sales adjustments include e.g. file failures.

For the avoidance of doubt: this Cell shall contain all relevant Usages of Releases plus all relevant Usages of Resources.

Integer

M

1234

Users

The number of Users with whom the Release or Resource were transacted.

IntegerO1234

Currency

The Currency in which the NetRevenue, AmountPayable and AllocatedNetRevenue are provided (represented by an ISO 4217 CurrencyCode.

AVS

M

CAD

NetRevenue

Net Revenue of the MessageSender for the Territory, CommercialModel  and UseType. This element is, in most cases, the basis for royalty calculations.

Float

M

10545.12

RightsController 

Name of the RightsController that is believed by the MessageSender to control a RightShare of the Work

String

O

SACEM

RightsControllerPartyId

PartyId of the RightsController that is believed by the MessageSender to control a RightShare of the Work

PartyIdOISNI::0000000081266409

Allocated Usages

The number of Usages allocated to the RightsController.

Multiple float

O

411.29

AmountPayable

The amount due to the RightsController for the Uses reported

Multiple float

O

20.45

AllocatedNetRevenue

Net Revenue of the generated that are to be ascribed to the RightsController

Float

O

781.73

 6.2.3 SY03 – Summary Record for Subscription Services

6.2.3.1 Purpose of Record

This Record can be used to communicate summary information about Usages, Sales and Revenues with support for subscription services.

6.2.3.2 Definition of Cells

Cell NameField DefinitionData TypeM/O/C?Example

RecordType

The Type of the Record; always to contain “SY03”

Fixed string

M

SY03

SummaryRecordId The Identifier (specific to the Message) of the Summary Record. This Identifier shall be used by Usage/Revenue/Sales Records to indicate to which Summary Record they provide details. StringM34
DistributionChannelThe Licensee on whose behalf the Sales/Usage has been generated.StringCMyCo
DistributionChannelDPIDThe DDEX Party ID of the DistributionChannelDPIDCDPIDA12345SDF

CommercialModel

The Type of CommercialModel of the SalesTransaction. The CommercialModel indicates how a Consumer pays for a Service or Release.

AVS

M

SubscriptionModel

UseType

The nature of a Service, or a Release, as used by a Consumer.

AVS

M

Stream

Territory

The Territory for which the sale/transaction is reported.

AVS

M

FR

ServiceDescription

The service name (e.g. a service tier) under which the SalesTransaction took place. The ServiceDescription may not contain space characters or underscores.

String

M

Premium Service

Usages

The number of Usages of the Release or Resource from the MessageSender to Consumers, including any sales adjustments. Sales adjustments include e.g. file failures.

For the avoidance of doubt: this Cell shall contain all relevant Usages of Releases plus all relevant Usages of Resources.

Integer

M

1234

Subscribers

The number of paying Subscribers

Float

M

1239867

Currency

The Currency in which the NetRevenue, ConsumerPaidUnitPrice, AmountPayable and AllocatedNetRevenue are provided (represented by an ISO 4217 CurrencyCode.

AVS

M

CAD

NetRevenue

Net Revenue of the MessageSender for the Territory, CommercialModel   and UseType. This element is, in most cases, the basis for royalty calculations.

Float

M

10545.12

RightsController

Name of the RightsController that is believed by the MessageSender to control a RightShare of the Work

String

O

SACEM

RightsControllerPartyId

PartyId of the RightsController that is believed by the MessageSender to control a RightShare of the Work

PartyIdOISNI::0000000081266409

AllocatedUsages

The number of Usages allocated to the RightsController.

Multiple float

O

411.29

AmountPayable

The amount due to the RightsController for the Usages, Revenues or Sales reported

Multiple floats

O

20.45

AllocatedNetRevenue

Net Revenue of that which is generated that is to be ascribed to the RightsController

Float

O

781.73

RightsController MarketShare

The ratio in percent between NumberOfUser s and AllocatedUsages.

Float

O

18.25

ConsumerPaidUnitPrice

The average price paid by the Subscribers

Float

M

6.62

FreeOrTrialSubscribersThe number of non-paying Subscribers (including Subscribers in a non-paying trial period).

Float

M

1239867

ExchangeRateBaseCurrencyThe currency in which the revenue has to be reported.AVSOUSD

ExchangeRate

The Exchange rate used to calculate the AmountPayable in the specified Currency

Float

O

1.205648

 6.3 Release Records
 6.3.1 RE01 – Basic Audio Release Record

6.3.1.1 Purpose of Record

This is the Record to describe audio Releases that have been used or sold. This specifically also includes music videos.

6.3.1.2 Definition of Cells

Cell NameField DefinitionData TypeM/O/C?Example

RecordType

The Type of the Record; always to contain “RE01”

Fixed string

M

RE01

BlockId

The Identifier (specific to the Message) of the Block that this Record belongs to. All Records in a single Block shall have the same BlockId

String

M

7

ReleaseReference

The Identifier (specific to the Block) of the Record, that allows other Records to reference this Record. Within a Block, the ReleaseReference shall be unique across all Release Records.

String

M

15

DspReleaseId

The ProprietaryIdentifier of the Release assigned by the MessageSender

String

M

12345678

ProprietaryReleaseId

The ProprietaryIdentifier of the Release preceded by a namespace identifier in the syntax ns::id

Multiple String::String

O

myns::4534|ns2::4345

CatalogNumber

The catalogue number of the Release assigned by the issuing record company

String

O

123456

ICPN

The ICPN used as proxy for identification of the Release. An ICPN comprises 12 or 13 digits, depending whether it is an EAN (13) or a UPC (12). 14 character ICPNs are also permitted.

String

O

12345678904321

DisplayArtistName

The Name to be used by a DSP when presenting Artist details of the Release to a Consumer

String

M

The Beatles

DisplayArtistPartyId

The PartyId of the DisplayArtist

PartyIDOISNI::0000000081266409

Title

The ReferenceTitle of the Release

String

M

Beatles for Sale

SubTitle

A Descriptor which is supplementary to, but not contained within, a Title

String

O

Live Version

ReleaseType

The form in which a ReleaseCreator anticipates offering the Release to Consumers.

AVS

O

Album

Label

The Name of the Label for the Release.

String

O

Apple Records

PLine

The Pline for the Release

String

O

℗1970 Apple Records

DataProvider

The Name of the company that provided the Release information to the MessageSender

String

O

UMG

 6.3.2 RE02 – Basic Sub-Release Record

6.3.2.1 Purpose of Record

This is the Record to describe Sub-Releases that have been used or sold.

6.3.2.2 Definition of Cells

Cell NameField DefinitionData TypeM/O/C?Example

RecordType

The Type of the Record; always to contain “RE02”.

Fixed string

M

RE02

BlockId

The Identifier (specific to the Message) of the Block that this Record belongs to. All Records in a single Block shall have the same BlockId

String

M

7

ReleaseReference

The Identifier (specific to the Block) of the Record, that allows other Records to reference this Record. Within a Block, the ReleaseReference shall be unique across all Release Records.

String

M

15

DspReleaseId

The ProprietaryIdentifier of the Release assigned by the MessageSender

String

M

12345678

ProprietaryReleaseId

The ProprietaryIdentifier of the Release preceded by a namespace identifier in the syntax ns::id

Multiple String::String

O

myns::4534|ns2::4345

UsedResources

List of ResourceReferences of the Resources (reported in the same Block) that make up the Sub-Release

Multiple String

M

2|4|6|3

 6.4 Resource Records

 6.4.1 AS01 – Basic Sound Recording Record

6.4.1.1 Purpose of Record

This is the Record to describe sound recordings and music videos that have been used or sold individually or as part of a Release (without Musical Work Information). This specifically also includes music videos.

6.4.1.2 Definition of Cells

Cell NameField DefinitionData TypeM/O/C?Example

RecordType

The Type of the Record; always to contain “AS01”

Fixed string

M

AS01

BlockId

The Identifier (specific to the Message) of the Block that this Record belongs to. All Records in a single Block shall have the same BlockId

String

M

7

ResourceReference

The Identifier (specific to the Block) of the Record, that allows other Records to reference this Record

String

M

15

DspResourceId

The ProprietaryIdentifier of the Resource assigned by the MessageSender

String

M

12345678

ISRC

The ISRC (International Standard Recording Code as defined in ISO 3901) for the SoundRecording. An ISRC comprises four parts: two characters, followed by three alphanumeric characters, then two digits and five digits.

String

C

USS1Z1412345

Title

The ReferenceTitle of the SoundRecording.

String

M

Bohemian Rhapsody

SubTitleA Descriptor which is supplementary to, but not contained within, a Title.StringOLive Version
DisplayArtistName

The Name to be used by a DSP when presenting Artist details of the Resource to a Consumer.

StringMQueen
DisplayArtistPartyIdThe PartyId of the DisplayArtistPartyIDOISNI::0000000081266409
DurationThe Duration of the SoundRecording (using the ISO 8601:2004 PT[[hhH]mmM]ssS format, where lower case characters indicate variables, upper case characters are part of the string, e.g. one hour, two minutes and three seconds would be PT1H2M3S). The seconds section ss may include fractions (e.g. one minute and 30.5 seconds would be PT1M30.5S).ISO durationMPT1H2M3S
ResourceType

The Type of the Resource

AVSMSoundRecording

6.4.1.3 Conditions

The ISRC must be provided if they are available to the Message Sender.

 6.4.2 AS02 – Basic Sound Recording Record with Musical Work Details

6.4.2.1 Purpose of Record

This is the Record to describe sound recordings and music videos that have been used or sold individually or as part of a Release (with Musical Work Information). This specifically also includes music videos.

6.4.2.2 Definition of Cells

The AS02 Record has the same structure as defined above, with two differences. Firstly, the RecordType shall contain the string AS02, instead of AS01, and, secondly, the following Cells will appear in addition, and to the right of, the Cells defined above.

Cell NameField DefinitionData TypeM/O/C?Example

ISWC

The ISWC (International Standard Musical Work Code defined in ISO 15707) identifying the MusicalWork. An ISWC comprises three parts: the letter 'T', followed by nine digits and then one check digit.

String

C

T0030749586

ComposerAuthor

The Name of a Writer of the Musical Work used in creating the Resource

Multiple String

C

Johann Sebastian Bach

ComposerAuthorPartyIdThe PartyId(s) of the ComposerAuthor(s)Multiple PartyIDOISNI::0000000081266409

Arranger

The Name of an Arranger of the Musical Work used in creating the Resource

Multiple String

C

August Wilhelmj

ArrangerPartyIdThe PartyId(s) of the Arranger(s)Multiple PartyIDOISNI::0000000081266409
MusicPublisher

The Name of the MusicPublisher(s) of the Musical Work for the relevant Territory.

Multiple StringCUMP
MusicPublisherPatryIdThe PartyID(s) of the MusicPublisher(s).Multiple PartyIDOISNI::00000000111111111

WorkContributor

The Name of a contributor of the Work. This Cell shall only be used if the Message Sender does not know whether the contributor is a ComposerAuthor or an Arranger, or if the contributor played a role other than a  ComposerAuthor or Arranger.

Multiple String

C

UMP

WorkContributorPartyIdThe PartyId(s) of the WorkControibutor(s)Multiple PartyIDOISNI::0000000081266409

6.4.2.3 Definition of Conditions

The following Cells must be provided if they are available to the Message Sender: ISWC, ComposerAuthor, Arranger, MusicPublisher and WorkContributor.

 6.5 Work and Cue Records
 6.5.1 MW01 – Basic Musical Work Record

6.5.1.1 Purpose of Record

This is the basic Record to describe a Musical Work that has been utilised.

6.5.1.2 Definition of Cells

Cell NameField DefinitionData TypeM/O/C?Example

RecordType

The Type of the Record; always to contain “MW01”

Fixed string

M

MW01

BlockId

The Identifier (specific to the Message) of the Block that this Record belongs to. All Records in a single Block shall have the same BlockId

String

M

7

DspWorkId

The ProprietaryIdentifier of the Musical Work assigned by the MessageSender

String

M

12345678

ISWC

The ISWC (International Standard Musical Work Code defined in ISO 15707) identifying the MusicalWork. An ISWC comprises three parts: the letter 'T', followed by nine digits and then one check digit.

String

C

T0030749586

Title

The ReferenceTitle of the Musical Work

String

M

Bohemian Rhapsody

SubTitle

A Descriptor which is supplementary to, but not contained within, a Title.

String

O

Live version

ComposerAuthor

The Name of a Writer of the Musical Work used in creating the Resource

Multiple String

C

Johann Sebastian Bach

ComposerAuthorPartyIdThe PartyId(s) of the ComposerAuthor(s)Multiple PartyID(s)OISNI::0000000081266409

Arranger

The Name of an Arranger of the Musical Work used in creating the Resource

Multiple String

C

August Wilhelmj

ArrangerPartyIdThe PartyId(s) of the Arranger(s)Multiple PartyID(s)OISNI::0000000081266409
MusicPublisher

The Name of the MusicPublisher(s) of the Musical Work for the relevant Territory.

Multiple StringCUMP
MusicPublisherPatryIdThe PartyID(s) of the MusicPublisher(s).Multiple PartyIDOISNI::00000000111111111

WorkContributor

The Name of a  contributor of the Work. This Cell shall only be used if the Message Sender does not know whether the contributor is a ComposerAuthor or an Arranger, or if the contributor played a role other than a  ComposerAuthor or Arranger.

Multiple String

C

UMP

WorkContributorPartyIdThe PartyId(s) of the WorkContributor(s)Multiple PartyID(s)OISNI::0000000081266409

DataProvider

The Name of the company that provided the MusicalWork information to the MessageSender

String

O

UMG

6.5.1.3 Definition of Conditions

The following Cells must be provided if they are available to the MessageSender: ISWC, ComposerAuthor, Arranger, MusicPublisher and WorkContributor.

 6.6 Records to describe Usages, Sales or Revenues
 6.6.1 SU01 – Usage, Revenue or Sales Record for Download Services

6.6.1.1 Purpose of Record

This is the Record to communicate Usages, Revenues or Sales of Releases and/or Resources for download services or other similar services.

Records that describe Usages, Revenues or Sales do so with respect to a sales context (see Clause 6.5 in Part 1). The context is, however, not directly provided in the Record. Instead, the context is available in the Summary Record SYxx that the Sales/Usage Record points to through its SummaryRecordId Cell.

6.6.1.2 Definition of Cells

Cell NameField DefinitionData TypeM/O/C?Example

RecordType

The Type of the Record; always to contain “SU01”

Fixed string

M

SU01

BlockId

The Identifier (specific to the Message) of the Block that this Record belongs to. All Records in a single Block shall have the same BlockId

String

M

7

SummaryRecordIdThe Identifier (specific to the Message) of the Summary Record that this Usage, Revenue or Sales Record provides details for.
StringM34

SalesTransactionId

ProprietaryIdentifier of the Sales Transaction, allocated by the MessageSender, which allows an invoice to be tied back to an individual SalesTransaction composite/record. Globally and perpetually unique together with the Message ID. The SalesTransactionId may change when the report is re-generated.

String

M

34456

TransactedRelease

The Identifier (specific to the Block) of the Record describing the Release (either a Head Release or a SubRelease) whose Usages, Revenues or Sales are being reported.

String

C

2345

TransactedResourceThe Identifier (specific to the Block) of the Record describing the Resource whose Usages, Revenues or Sales are being reported.StringC2345

IsRoyaltyBearing

The Boolean flag indicating whether the MessageSender is contractually obliged to pay royalties to the RightsController for the SalesTransaction reported in the Record.

Boolean

M

true

SalesUpgrade

A Flag indicating whether the SalesTransaction applies to an upgraded Release (=true) or not (=false)

Boolean

M

false

Usages

The number of Usages of the Release by Consumers using the MessageSender service, including any sales adjustments. Sales adjustments include e.g. file failures.

Integer

M

1000

Returns

The number of Usages of a Release returned (with refund) to the MessageSender as a result of a reversal of a SalesTransaction or because of an earlier error in sales reporting.

Integer

M

2

PriceConsumer PaidExcSalesTax

A Price paid by Consumers, excluding SalesTax for each SalesTransaction. This may be a nominal price.

Float

C

100.34

PromotionalActivity

Free-text Description of a promotional activity that led to the Release being distributed.

String

O

Valentines Day Special

6.6.1.3 Definition of Conditions

PriceConsumerPaidExcSalesTax is mandatory when the CommercialModel is PAYG. Currency is Mandatory when one financial field is provided. Either a TransactedRelease or a TransactedResource must be provided.


 6.6.2 SU02 – Usage, Revenue or Sales Record for Streaming Services and Webcasts

6.6.2.1 Purpose of Record

This is the Record to communicate Usages, Revenues or Sales of Releases and/or Resources for streaming services or other similar services.

Records that describe Usages, Revenues or Sales do so with respect to a sales context (see Clause 6.5 in Part 1). The context is, however, not directly provided in the Record. Instead, the context is available in the Summary Record SYxx that the Sales/Usage Record points to through its SummaryRecordId Cell.

6.6.2.2 Definition of Cells

Cell NameField DefinitionData TypeM/O/C?Example

RecordType

The Type of the Record; always to contain “SU02”

Fixed string

M

SU02

BlockId

The Identifier (specific to the Message) of the Block that this Record belongs to. All Records in a single Block shall have the same BlockId

String

M

7

SummaryRecordIdThe Identifier (specific to the Message) of the Summary Record that this Usage, Revenue or Sales Record provides details for.
StringM34

SalesTransactionId

ProprietaryIdentifier of the Sales Transaction, allocated by the MessageSender, which allows an invoice to be tied back to an individual SalesTransaction composite/record. Globally and perpetually unique together with the Message ID. The SalesTransactionId may change when the report is re-generated.

String

M

34456

TransactedRelease 

The Identifier (specific to the Block) of the Record describing the Release (either a Head Release or a SubRelease) whose Usages, Revenues or Sales are being reported.

String

C

2345

TransactedResourceThe Identifier (specific to the Block) of the Record describing the Resource whose Usages, Revenues or Sales are being reported.StringC2345

IsRoyaltyBearing

The Boolean flag indicating whether the MessageSender is contractually obliged to pay royalties to the RightsController for the SalesTransaction reported in the Record.

Boolean

M

true

NumberOfStreams

The number of Streams of the Release from the MessageSender to Consumers.

Integer

M

1000

PriceConsumer PaidExcSalesTax

A Price paid by Consumers, excluding SalesTax for each SalesTransaction. This may be a nominal price.

Float

C

100.34

PromotionalActivity

Free-text Description of a promotional activity that led to the Release being distributed.

String

O

Valentines Day Special

6.6.2.3 Definition of Conditions

PriceConsumer-PaidExcSalesTax is mandatory when the CommercialModel  is PAYG. Currency is Mandatory when one financial field is provided. Either a TransactedRelease or a TransactedResource must be provided.

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.

[SAMPLES WILL BE ADDED BEFORE PUBLICATION]

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.