THIS IS AN OLD VERSION. 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.

Version 3 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. 

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.


Essential Reading

Download/Print standard (PDF)

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

 

 

2 Scope

 2.1 Introduction
The message design 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, 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 Sound Recordings and/or Music Audio-Visual Recordings which embody Musical Works and/or other Resources.

Such data is provided, in accordance with the overall architecture defined in Part 1, in a series of Record. The order of these Records is defined in the relevant Profile (as documented in a seperate Part of this standard) whereas the syntax and semantics of each Record is  defined in this Part 8.

 2.2 Organisation of the Standard
This standard comprises five clauses. Clauses 1-4 provide the scope, abbreviations and core definitions used in this standard. Clause 5 provides the Allowed Value Sets and Allowed Values, each with definitions, used in the Profiles defined for the flat-file Sales/Usage Reporting Standard.

 2.3 Release Notes (Informative)
Version 1.0.1 corrects an error in the AS02.01, SU05 and LI01 records.

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 Data Dictionary Standard. Latest Version
  • DDEX. Digital Sales Reporting Message Suite Standard - Part 1: Architecture of the Flat File Variant.

4 Terms and Abbreviations

 Click here to expand...

5 Record Type Definitions

 5.1 Header and Footer Record Types

 5.1.1 HEAD – Header Record
This is the Header Record for all Sales Report Messages created in accordance with this standard. Each file of a Sales Report Message shall have exactly one such Header Record. It shall be the first Record in each file.

The ServiceDescription shall only be used if it aids the MessageRecipient in determining the sales context(s) of the Message.


Cell Name Field DefinitionData TypeM/O/C?[1]Example
1

RecordType

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

Fixed string

M

HEAD

2

MessageVersion

The Version of the Message. This shall be in the form dsrf/xxx/yyy/zzz with

  • xxx being the version number of Part 1 (Architecture)
  • yyy being the version number of Part 2 (Allowed Value Sets) and
  • zzz being the version number of Part 8 (Record Type Definitions) that is needed to ingest the Message. This document represents version 1.0.1.

dsrf/1.1.2/1.6/1.0 would therefore signal that the Message was created in accordance with the Architecture in version 1.1.2, the allowed value set of version 1.6 and the Record Type Record Type Definitions of version 1.0.

If the MessageVersion is provided as dsrf/30, Parts 1 and 2 are deemed to be in the initial version as published in 2016. This capability has been retained for backwards compatibility.

Fixed string

M

dsrf/1.1.2/1.6/1.0

3ProfileThe Identifier of the Profile used for the Message.StringMBasic Audio Profile
4

ProfileVersion

The Identifier of the Version of the Profile used for the Message. The value for this field is defined in the relevant Profile standard.

String

M

1.0

5

MessageId

A string used to uniquely identify the Message. The MessageId shall be, in combination with the MessageSenderId, globally unique. Thus, a MessageSender shall never re-use a MessageId.

String

M

1234567890

6

MessageCreatedDateTime

The DateTime on which the Message was created (the only allowed format is ISO 8601:2004: YYYY-MM-DDThh:mm:ssTZD).

ISO datetime

M

2014-12-14T10:05:00Z

7

FileNumber

Sequence number of the file within the Flat File Sales Report Message. The first file shall be numbered “1”. The FileNumber must not be larger that NumberOfFiles

Integer

M

2

8

NumberOfFiles

The number of files that the Sales Report is provided in.

Integer

M

3

9

UsageStartDate

The StartDate of the reporting Period covered by the Message (in ISO 8601:2004 format). This is a string with the syntax YYYY[-MM[-DD]].

ISO date

M

2014-12-01

10

UsageEndDate

The EndDate of the reporting Period covered by the Message (in ISO 8601:2004 format). This is a string with the syntax YYYY[-MM[-DD]].

ISO date

M

2014-12-01

11

SenderPartyId

The DDEX PartyId (DPID) of the MessageSender

DDEX Party ID

M

PADPIDA2008120501W

12

SenderName

The Full Name of the MessageSender

String

M

Apple

13

ServiceDescription

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

The ServiceDesctiption is intended to be a human-readable expression of the totality of the services reported in the Message. For sales/usage reports covering one sales context (see Clause 6.5 in Part 1) this should be the same is being the same string used in the file name (see Clause 9.1 in Part 1) and the single Summary Record contained in the Message.

For sales reports covering multiple sale contexts, the ServiceDescription in the Header should be the same as on the file name and represent a human-readable summary of the sales contexts provided in the Summary Records.

String

C

PremiumService

14

RecipientPartyId

The DDEX PartyId (DPID) of the MessageRecipient. This element is mandatory when the Sales Report Message is sent to one MessageRecipient and must not be included when the Sales Report Message is sent to more than one MessageRecipient.

DDEX Party ID

O

PADPIDA2007081601G

15

RecipientName

The Full Name of the MessageRecipient. This element is mandatory when the Sales Report Message is sent to one MessageRecipient and must not be included when the Sales Report Message is sent to more than one MessageRecipient.

String

O

SACEM

16

RepresentedRepertoire

Content owners represented by the MessageRecipient. This only needs to be provided if there are more than one repertoires being administered by the MessageRecipient.

Multiple strings

O

GEMA|PAECOL

 



[1] Mandatory – Optional – Conditional

 5.1.2 FOOT – Footer Record
This is the Footer Record for all Sales Report Messages created in accordance with this standard. Each Sales Report Message shall have exactly one such Footer Record. It shall be the last Record in the Sales Report Message.

NumberOfLinesInReport and NumberOfBlocksInReport are only mandatory in the last file of a Sales Report Message.


Cell NameField DefinitionData TypeM/O/C?Example
1

RecordType

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

Fixed string

M

FOOT

2

NumberOfLinesInFile

 

Number of data lines communicated in the file, including Header and Footer Records as well as empty Records in accordance with Clause 6.6.7 and commented-out Records in accordance with Clause 6.6.9 .IntegerM109
3

NumberOfLinesInReport

Number of data lines communicated in the Sales Report Message, including Header and Footer Records as well as empty Records in accordance with Clause 6.6.7 and commented-out Records in accordance with Clause 6.6.9. For single-file reports the NumberOfLinesInReport is the same as NumberOfLinesInFile. In multi-file reports, NumberOfLinesInFile is smaller than NumberOfLinesInReport.

Integer

C

1234

4NumberOfSummaryRecordsNumber of Records in accordance with t he relevant profile . IntegerM20
5NumberOfBlocksInFile
Number of Blocks of Records in the file in accordance with t he relevant profile .
IntegerM10
6NumberOfBlocksInReport

Number of Blocks of Records in the Sales Report Message accordance with th e relevant profile .

IntegerC65

 5.2 Summary Record Types

 5.2.1 SY01 – Basic Summary Record
This is the Record to communicate basic summary information about Usages, Sales and Revenues.

Subscribers shall only be provided when the service is based on subscriptions. IndirectNetRevenue shall only be provided when indirect revenues were generated. ServiceDescription shall be provided if a Message Sender offers multiple services that need to be differentiated in this sales/usage report.

 

Cell NameField DefinitionData TypeM/O/C?Example
1RecordType

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

Fixed stringMSY01
2SummaryRecordId
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
3DistributionChannelThe Licensee on whose behalf the Sales/Usage has been generated.StringCMyCo
4DistributionChannelDPIDThe DDEX Party ID of the DistributionChannel.DPIDCDPIDA12345SDF
5CommercialModel

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

AVSMPayAsYouGoModel
6UseType

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

AVSMPermanentDownload
7Territory

The Territory for which the sale/transaction is reported.

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

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
10Subscribers

The number of subscribers to a Service 

FloatC12345
11Currency

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

AVSMCAD
12NetRevenue

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
13IndirectNetRevenue

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

FloatC13424.50
 5.2.2 SY02 – Summary Record for Ad-Supported and Interactive Streaming Services
This Record can be used to communicate summary information about Usages, Sales and Revenues with support for ad supported and interactive streaming services.
Cell NameField DefinitionData TypeM/O/C?Example
1

RecordType

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

Fixed String

M

SY02

2SummaryRecordIdThe 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
3DistributionChannelThe Licensee on whose behalf the Sales/Usage has been generated.StringCMyCo
4DistributionChannelDPID

The DDEX Party ID of the DistributionChannel.

DPIDCDPIDA12345SDF
5

CommercialModel

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

AVS

M

AdvertisementSupportedMode

6

UseType

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

AVS

M

Stream

7

Territory

The Territory for which the sale/transaction is reported.

AVS

M

FR

8

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

PremiumService

9

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

10Users

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

IntegerO1234
11

Currency

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

AVS

M

CAD

12

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

13

RightsController 

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

String

O

SACEM

14RightsControllerPartyId

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

PartyIdOISNI::0000000081266409
15

AllocatedUsages

The number of Usages allocated to the RightsController.

The order of the individual figures reported in AllocatedUsages and AllocatedRevenue shall be the same so that the recipient is able to relate figures correctly.

Multiple float

O

411.29

16

AllocatedRevenue

The amount due to the RightsController for the Uses reported

The order of the individual fights of AllocatedUsages and AllocatedRevenue shall be the same so that the recipient is able to relate figures correctly.

Multiple float

O

20.45

17

AllocatedNetRevenue

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

The order of the individual figures reported in AllocatedUsages, AllocatedRevenue and AllocatedNetRevenue shall be the same so that the recipient is able to relate figures correctly.

Float

O

781.73

 5.2.3 SY02.01 – Summary Record for Ad-Supported and Interactive Streaming Services (with RightsType)
This Record Type is an update to the SY02 Record Type defined in above and has the same structure as SY02, albeit with two differences:
  • The RecordType shall contain the string SY02.01, instead of SY02; and
  • The following Cell will appear in addition, and to the right of, the Cells defined in SY02:

 

Additional Cell NameField DefinitionData TypeM/O/C?Example
18

RightsType

 A Type of Right which is covered.

AVS

O

MechanicalRight
 5.2.4 SY03 – Summary Record for Subscription Services
This Record can be used to communicate  summary information about  Usages, Sales and Revenues with support for subscription services.

 

Cell NameField DefinitionData TypeM/O/C?Example
1

RecordType

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

Fixed string

M

SY03

2SummaryRecordId 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
3DistributionChannelThe Licensee on whose behalf the Sales/Usage has been generated.StringCMyCo
4DistributionChannelDPIDThe DDEX Party ID of the DistributionChannelDPIDCDPIDA12345SDF
5

CommercialModel

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

AVS

M

SubscriptionModel

6

UseType

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

AVS

M

Stream
7

Territory

The Territory for which the sale/transaction is reported.

AVS

M

FR

8

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

PremiumService

9

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

10

Subscribers

The number of paying Subscribers

Float

M

1239867

11

Currency

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

AVS

M

CAD

12

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

13

RightsController

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

String

O

SACEM

14RightsControllerPartyId

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

PartyIdOISNI::0000000081266409
15

AllocatedUsages

The number of Usages allocated to the RightsController.

Multiple float

O

411.29

16

AllocatedRevenue

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

Multiple floats

O

20.45

17

AllocatedNetRevenue

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

Float

O

781.73

18

RightsControllerMarketShare

The ratio in percent between NumberOfUser s and AllocatedUsages.

Float

O

18.25

19

ConsumerPaidUnitPrice

The average price paid by the Subscribers

Float

M

6.62

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

Float

M

1239867

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

ExchangeRate

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

Float

O

1.205648

 5.2.5 SY04 — Per-subscriber Minima Summary Record for Subscription Services
This is the Record to summarise usage-independent per subscriber minima that apply to a series of sales/usages, typically in the context of subscription services.

It is permissible that multiple SY04 records carry the same SummaryRecordId value as long as they carry the same sales/usage context information (as defined in Clause 6.5 of Part 1 of this standard), i.e. the same DistributionChannel, DistributionChannelDPID, CommercialModel, UseType, Territory. This allows multiple sales/usage Records to refer to this group of the SY04 Records and their context.

All conditional elements shall be provided when essential to the commercial relationship being reported on. ReportingSubperiodStartDate and ReportingSubperiodEndDate shall only be provided when they differ from the UsageStartDate and UsageEndDate in the message header Record. ReportingSubperiodStartDate and ReportingSubperiodEndDate shall always be provided together. UsagesInSubPeriod and UsagesInReportingPeriod are conditional depending on the commercial relationship between Message Sender and Message Recipient

 

Cell Name

Field Definition

Data Type

M/O/C

Example

1

RecordType

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

Fixed string

M

SY04

2

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.

String

M

34

3

DistributionChannel

The Licensee on whose behalf the Sales/Usage has been generated.

String

C

MyCo

4

DistributionChannelDPID

The DDEX Party ID of the DistributionChannel

DPID

C

DPIDA12345SDF

5

CommercialModel

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

AVS

M

SubscriptionModel

6

UseType

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

AVS

M

Stream

7

Territory

The Territory for which the sale/transaction is reported.

AVS

M

FR

8

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

PremiumService

9

SubscriberType

The type of Subscriber.

String

M

Student

10

Subscribers

The number of Subscribers of the SubscriberType

Float

M

1239867

11

SubPeriodStartDate

The StartDate of the reporting Period covered by the Summary Record (in ISO 8601:2004 format) to allow reporting per-subscriber minima more granular than the overall reporting period. This is a string with the syntax YYYY[-MM[-DD]].

The ReportingSubperiodStartDate must not be earlier than than the UsageEndDate provided in the relevant header record.

Date

C

2014-12-01

12

SubPeriodEndDate

The EndDate of the reporting Period covered by the Summary Record (in ISO 8601:2004 format) to allow reporting per-subscriber minima more granular than the overall reporting period. This is a string with the syntax YYYY[-MM[-DD]].

The ReportingSubperiodEndDate must not be later than than the UsageEndDate provided in the relevant header record.

Date

C

2014-12-01

13

UsagesInSubPeriod

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

C

1234

14

UsagesInReportingPeriod

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

C

1234

15

Currency

Currency used to report Net Revenue, AllocatedNetRevenue and AllocatedRevenue (represented by an ISO 4217 CurrencyCode).

AVS

M

CAD

16

ExchangeRateBaseCurrency

Currency used for ConsumerPaidUnitPrice (represented by an ISO 4217 CurrencyCode).

AVS

O

USD

17

ExchangeRate

The Exchange rate used to convert ExchangeRateBaseCurrency in the Currency.

Float

O

1.205648

18

ConsumerPaidUnitPrice

The average price paid by the Subscribers

Float

M

6.62

19

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


 5.2.6 SY05 — Licensor Usage and Revenue Summary Record for Subscription Services
This is the Record to summarise subscription service-based sales/usages for individual Licensors.

DistributionChannel, DistributionChannelId, TotalUsages and MusicUsageRatio shall be provided when essential to the commercial relationship being reported on.  ServiceDescription shall be provided if a Message Sender offers multiple services that need to be differentiated in this sales/usage report.


Cell Name

Field Definition

Data Type

M/O/C

Example

1

RecordType

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

Fixed string

M

SY05

2

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.

String

M

34

3

DistributionChannel

The Licensee on whose behalf the Sales/Usage has been generated.

String

C

MyCo

4

DistributionChannelDPID

The DDEX Party ID of the DistributionChannel

DPID

C

DPIDA12345SDF

5

CommercialModel

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

AVS

M

SubscriptionModel

6

UseType

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

AVS

M

Stream

7

Territory

The Territory for which the sale/transaction is reported.

AVS

M

FR

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

RightsController

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

String

O

SACEM

10

RightsControllerPartyId

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

PartyId

O

ISNI::0000000081266409

11

RightsType

Type of Right for which the Revenue and Usages applies

AVS

M

PerformingRight

12TotalUsagesThe number of Usages generated by the Service.IntegerC2324
13

AllocatedUsages

The number of Usages allocated to the RightsController.

Multiple float

O

411.29

14MusicUsageRatioA Rate for the usages of Resources with musical content in relation to the usages of all Resources.FloatC34.7687
15

AllocatedNetRevenue

The amount due to the RighsController for the Uses, Revenue or Sales.

Multiple floats

O

20.45

16

AllocatedRevenue

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

Float

O

781.73

17

RightsControllerMarketShare

The ratio in percent between NumberOfUser s and AllocatedUsages.

Float

O

18.25


 5.2.7 SY06 – Summary Record for AV Content
Summary Record to summarise audio-visual Sales/Usages.  

All conditional elements are mandatory when available to the MessageSender. Subscribers shall only be provided when the service is based on subscriptions. IndirectNetRevenue shall only be provided when indirect revenues were generated. All other All conditional elements are mandatory when available to the MessageSender.

Cell Name

Field Definition

Data Type

M/O/C

Example

1

RecordType

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

Fixed string

M

RE03

2

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.

String

M

7

3

DistributionChannel

The Licensee on whose behalf the Sales/Usage has been generated.

String

C

MyCo

4

DistributionChannelDPID

The DDEX Party ID of the DistributionChannel

DPID

C

DPIDA12345SDF

5

CommercialModel

TheType of CommercialModel of the SalesTransaction. The

CommercialModel Indicates how a Consumer pays for a Service or Release.

AVS

M

PayAsYouGoModel

6

UseType

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

AVS

M

PermanentDownload

7

Territory

The Territory for which the sale/transaction is reported.

AVS

M

DE

8

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

PremiumService

9

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

123554

10

Subscribers

The number of subscribers to a Service

Float

C

123445

11

Currency

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

AVS

M

CAD

12

NumberOfReleases

Total number of Releases reported in the Message

New Cell proposed by FX

Integer

O

64

13

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).

Float

O

223345.12

14

IndirectNetRevenue

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

Float

C

13424.50

15

PreviewAvailable

Flag of whether the service offers previews.

Note, this is independent from whether any previews were accessed by Consumers.

Boolean

O

true


 5.2.8 SY07 – Summary Record for Royalty Reports
This is the Record to communicate basic summary information about Royalties.

All DistributionChannel, DistributionChannelDPID, UseType and NetRevenue shall be provided when applicable in the relevant business relationship.

 

Cell Name

Field Definition

Data Type

M/O/C

Example

1

RecordType

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

Fixed String

M

SY07

2

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.

String

M

44

3

DistributionChannel

The Licensee on whose behalf the Sales/Usage has been generated.

String

C

MyCo

4

DistributionChannelDPID

The DDEX Party ID of the DistributionChannel

DPID

C

DPIDA12345SDF

5

CommercialModel

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

AVS

O

PayAsYouGoModel

6

UseType

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

AVS

C

Download

7

Territory

The Territory for which the Royalty is reported.

AVS

M

DE

8

RightsType

The RightsType for which the Royalty is reported.

AVS

M

MechanicalRight

9

ServiceDescription

The service name (e.g. a service tier) under which the SalesTransaction took place.

String

O

PremiumService

10

Usages

The number of Usages of the Release 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

1909

11

Users

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

Integer

O

323

12

Currency

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

AVS

M

EUR

13

NetRevenue

Net Revenue of the MessageSender for the Territory and RightyType.

Decimal

C

1009.21

14

RightsController

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

String

O

TestCompany

15

RightsControllerPartyId

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

PartyId

O

DPIDA12345SDF

16

AllocatedUsages

The number of Usages allocated to the RightsController.

Multiple Float

O

123.2

17

AllocatedRevenue

The amount allocated to the RightsController for the Uses reported

Float

M

234.12

18

AllocatedNetRevenue

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

Float

M

12.99

 5.2.9 SY08 – Summary Record for Broadcast Reports
This is the Record to communicate basic summary information about Broadcast usages.

DistributionChannel, DistributionChannelDPID, and IndirectNetRevenue shall be provided when applicable in the relevant business relationship. A RughtsType shall be provided when it applies to the broadcast Resource.

 

Cell Name

Field Definition

Data Type

M/O/C

Example

1

RecordType

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

Fixed String

M

SY08

2

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.

String

M

123

3

DistributionChannel

The Licensee on whose behalf the Sales/Usage has been generated.

String

C

MyCo

4

DistributionChannelDPID

The DDEX Party ID of the DistributionChannel.

DPID

C

DPIDA12345SDF

5

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

Beats

6

BroadcastStationOrChannel

The name for the station or channel where the Release or Resource was used

String

O

Beats Jazz

7

CommercialModel

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

AVS

M

AdvertisementSupportedModel

8

UseType

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

AVS

M

Broadcast

9

Territory

The Territory for which the sale/transaction is reported.

AVS

M

DE

10

NumberOfBroadcasts

Number of times the relevant Resource has been used by the BroadcastStationOrChannel

Integer

M

22

11

NumberOfBroadcastListeners

The number of times consumers consumed the Resource that has been broadcast

Integer

O

123

12

ListenerHours

Total number of hours that the Resource was listened to as part of the broadcast.

Float

M

123.4

13

Currency

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

AVS

M

EUR

14

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

565.86

15

IndirectNetRevenue

Net Revenue of the MessageSender not directly attributable to the transacted Release or Resource.

Float

C

120.81

16

RightsController

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

String

O

SACEM

17

RightsControllerPartyID

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

DPID

O

ISNI::0000000081266409

18

AllocatedRevenue

The amount due to the RightsController for the Uses reported

Float

O

102.09

19

RightsType

The right utilised in broadscating the Resource.

AVS

C

MechanicalRight

20

AllocatedNetRevenue

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

Float

O

19.11

21

RightsControllerAllocatedNumberOfBroadcasts

Number of broadcasts pro rated for the RightsController

Float

O

12

22

AdditionalData

Data specific to the commercial relationship between message sender and message recipient that cannot be communicated in any other cell.

String

O

 


 

 5.3 Release Record Types

 5.3.1 RE01 – Basic Audio Release Record
This is the Record to describe audio Releases that have been used or sold. This specifically also includes music videos.

 

Cell NameField DefinitionData TypeM/O/C?Example
1

RecordType

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

Fixed string

M

RE01

2

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

3

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. In the interest of keeping sales/usage reports as compact as possible, the ReleaseReference should typically be a short string, e.g. "1", "2", ...

String

M

15

4

DspReleaseId

The ProprietaryIdentifier of the Release assigned by the MessageSender

String

M

12345678

5

ProprietaryReleaseId

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

Multiple String::String

O

myns::4534|ns2::4345

6

CatalogNumber

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

String

O

123456

7

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

8

DisplayArtistName

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

String

M

The Beatles

9DisplayArtistPartyId

The PartyId of the DisplayArtist

PartyIDOISNI::0000000081266409
10

Title

The ReferenceTitle of the Release

String

M

Beatles for Sale

11

SubTitle

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

String

O

Live Version

12

ReleaseType

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

AVS

O

Album

13

Label

The Name of the Label for the Release.

String

O

Apple Records

14

PLine

The Pline for the Release

String

O

℗1970 Apple Records

15

DataProvider

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

String

O

UMG

 5.3.2 RE02 – Basic Sub-Release Record
This is the Record to describe Sub-Releases that have been used or sold.

 

Cell NameField DefinitionData TypeM/O/C?Example
1

RecordType

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

Fixed string

M

RE02

2

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

3

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. In the interest of keeping sales/usage reports as compact as possible, the ReleaseReference should typically be a short string, e.g. "1", "2", ...

String

M

15

4

DspSubReleaseId

The ProprietaryIdentifier of the Sub-Release assigned by the MessageSender. This ProprietaryIdentifier should be a globally unique identifier for the Sub-Release and not the globally unique identifier for the Head Releases that this Sub-Release has been taken from.

String

M

12345678

5

ProprietarySubReleaseId

The ProprietaryIdentifier of the Sub-Release preceded by a namespace identifier in the syntax ns::i. This ProprietaryIdentifier should be a globally unique identifier for the Sub-Release and not the globally unique identifier for the Head Releases that this Sub-Release has been taken from.

Multiple String::String

O

myns::4534|ns2::4345

6

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

 5.3.3 RE03 – Audio-visual Release Record
Basic Audio-visual Release Record to describe audio-visual Releases that have been used or sold.

 

Cell NameField DefinitionData TypeM/O/C?Example
1

RecordType

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

Fixed string

M

RE03

2

BlockId

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

String

M

7

3

ReleaseReference

The Identifier (specific to the Block) of the Record, that allows other Records to reference this Record. In the interest of keeping sales/usage reports as compact as possible, the ReleaseReference should typically be a short string, e.g. "1", "2", ...

String

M

15

4

DspReleaseId

The ProprietaryIdentifier of the Release assigned by the MessageSender

String

M

12345678

5

PoprietaryReleaseId

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

Multiple String::String

O

Myns::4534|ns2::4896

6

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)

String

O

1234567654321

7

Title

The ReferenceTitle of the Release

String

M

The Hamburger Postulate

8

SubTitle

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

String

O

 

9

SeriesTitle

The title of the Series that the Release is part of.

String

C

The Office

10

SeasonNumber

The number indicating the order of the Seasons within a Series.

Integer

C

7

11

DisplayArtistName

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

String

O

David Brent

12

DisplayArtistPartyId

The PartyId of the DisplayArtist

PartyId

O

ISNI::0000000081266409

13

ReleaseType

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

AVS

O

LongFormNonMusical-WorkVideoRelease

14

DataProvider

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

String

O

UMG

 5.4 Resource Record Types

 5.4.1 AS01 – Basic Sound Recording 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.

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

 

Cell NameField DefinitionData TypeM/O/C?Example
1

RecordType

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

Fixed string

M

AS01

2

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

3

ResourceReference

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

String

M

15

4

DspResourceId

The ProprietaryIdentifier of the Resource assigned by the MessageSender

String

M

12345678

5

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

6

Title

The ReferenceTitle of the SoundRecording.

String

M

Bohemian Rhapsody

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

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

StringMQueen
9DisplayArtistPartyIdThe PartyId of the DisplayArtistPartyIDOISNI::0000000081266409
10DurationThe 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
11ResourceType

The Type of the Resource

AVSMSoundRecording


 5.4.2 AS02 – Basic Sound Recording Record with Musical Work Details
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.

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

The AS02 Record has the same structure as AS01 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
1

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

2

ComposerAuthor

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

Multiple String

C

Johann Sebastian Bach

3ComposerAuthorPartyId

The PartyId(s) of the ComposerAuthor(s)

Multiple PartyIDOISNI::0000000081266409
4

Arranger

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

Multiple String

C

August Wilhelmj

5ArrangerPartyId

The PartyId(s) of the Arranger(s)

Multiple PartyIDOISNI::0000000081266409
6MusicPublisher

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

Multiple StringCUMP
7MusicPublisherPatryId

The PartyID(s) of the MusicPublisher(s).

Multiple PartyIDOISNI::00000000111111111
8

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

9WorkContributorPartyId

The PartyId(s) of the WorkControibutor(s)

Multiple PartyIDOISNI::0000000081266409
 5.4.3 AS02.01 – Basic Sound Recording Record with Musical Work Details and Proprietary ID
This Record Type is an update to the AS02 Record Type defined above and has the same structure as AS02, albeit with two differences:
  • The RecordType shall contain the string AS02.01, instead of AS02; and
  • The following Cell will appear in addition, and to the right of, the Cells defined in AS02.

 

Additional Cell NameField DefinitionData TypeM/O/C?Example
10

ProprietaryWorkId

The ProprietaryIdentifier of the Musical Work, preceded by a namespace identifier in the syntax ns::id

String::String

O

myns::4534

  Note: in a previous previous version this clause erroneously referenced AS01 and not AS02.


 5.4.4 AS03 – Audio-visual Resource Record
The AV Resource Record to describe audio-visual Resources that were used or sold individually or as part of a Release (without information on the underlying (non-musical) Work Information. This does not include music videos that are addressed elsewhere in this standard.

SeasonNumber has to be provided for seasons of TV series or parts thereof. EpisodeNumber has to be provided for TV series episodes.DirectorName must be provided when available to the MessageSender. The DirecrorName shall be mandatory for movies and documentaries when available to the MessageSender. LanguageLocalizationType, HasCaptioning, HasAudioDescription and CountryOfProduction shall be mandatory when available to the MessageSender. LanguageOfDubbing is mandatory when LanguageLocalizationType is Dubbed, SubTitled or Multilingual. OriiginalTitle, DateOfProductionOrRelease, ISAN and EIDR shall be mandatory when available to the MessageSender.

 

Cell NameField DefinitionData TypeM/O/C?Example
1

RecordType

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

Fixed string

M

AS03

2

BlockId

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

String

M

7

3

ResourceReference

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

String

M

15

4

DspResourceId

The ProprietaryIdentifier of the Resource assigned by the MessageSender

String

M

12345678

5

ISAN

The ISAN (International Standard Audiovisual Number as defined in ISO 15706) for the Video. An ISAN comprises four blocks of four hexadecimal characters followed by a check character followed, optionally by two further blocks of four hexadecimal characters, followed by a further check character.

String

C

0000-0001-8947-0000-8-0000-0000-D

6

EIDR

An Identifier of the Video assigned by the Entertainment Identifier Registry Association (EIDR).

String

C

10.5240/F85A-E100-B068-5B8F-B1C8-T

7

ProprietaryId

A Proprietary ID given to the Resource by, for instance a production house or a broadcaster. To identify the origin of the identifier, a namespace has to prefix the identifier, separated by the Secondary Delimiter.

String::String

O

BBC::12345

8

VideoType

The Type of the Video. As only one value can be selected, the primary VideoType needs to be provided.

Multiple AVSs

M

VideoReport
9

Title

The ReferenceTitle of the SoundRecording.

String

M

The Hamburger Postulate

10

SubTitle

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

String

O

Original Version

11

OriginalTitle

A Title given to a Creation by its Creator(s), in its original Language.

String

O

The Hamburger Postulate

12

SeasonNumber

The number indicating the order of the Seasons within a Series

Integer

C

1

13

EpisodeNumber

The number indicating the order of the Episodes within a Season (if available) or Series.

Integer

C

3

14

Genre

The genre or style (such as Musical, literary or audio-visual) with which the Resource is associated.

String

O

Horror Comedy

15

Duration

The Duration of he audio-visual Resource (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 duration

M

PT1H2M3S

16

ProducerName

The Name(s) of the producer(s) of the audio-visual Resource

Multiple Strings

O

Scott Kraft

17

ProducerPartyId

The PartyId(s) of the Producer(s)

Multiple PartyID

O

ISNI::0000000081266409

18

DirectorName

The Name(s) of the director(s) of the audio-visual Resource

Multiple Strings

C

Mark Cendrowski

19

DirectorPartyId

The PartyId(s) of the Director(s)

Multiple PartyID

O

ISNI::0000000081266409

20

ActorName

The Name(s) of the actor(s) of the audio-visual Resource

Multiple Strings

O

Jim Parsons

21

ActorPartyId

The PartyId(s) of the Actor(s)

Multiple PartyID

O

ISNI::0000000081266409

22

LanguageLocalizationType

Type of adaptation of an Audio-visual Resource for a specific audience and/or language.

AVS

C

Dubbe

23

HasCaptioning

A Flag indicating whether the audio-visual Resource has captioning to the hard of hearing and/or deaf.

Boolean

C

false

24

HasAudioDescription

A Flag indicating whether the audio-visual Resource has audio descriptions for the visually impaired and blind

Boolean

C

false

25

LanguageOfPerformance

The original Language of the Performance recorded in the audio-visual Resource

ISO Language Code

O

en

26

LanguageOfDubbing

The Language of dubbing used in the audio-visual Resource

ISO Language Code

O

de

27

DateOfProductionOrRelease

The date when the audio-visual resource was produced, or when it was first released, in the ISO 8601 format: YYYY[-MM[-DD]]

ISO date

C

2015

28

CountryOfProduction

The country or countries in which the audio-visual resource was produced

Multiple ISO Country Codes

C

GB|IE

 5.5 Work and Cue Record Types

 5.5.1 MW01 – Basic Musical Work Record
This is the basic Record to describe a Musical Work that has been utilised.

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

 

Cell NameField DefinitionData TypeM/O/C?Example
1

RecordType

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

Fixed string

M

MW01

2

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

3

DspWorkId

The ProprietaryIdentifier of the Musical Work assigned by the MessageSender

String

M

12345678

4

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

5

Title

The ReferenceTitle of the Musical Work

String

M

Bohemian Rhapsody

6

SubTitle

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

String

O

Live version

7

ComposerAuthor

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

Multiple String

C

Johann Sebastian Bach

8ComposerAuthorPartyId

The PartyId(s) of the ComposerAuthor(s)

Multiple PartyID(s)OISNI::0000000081266409
9

Arranger

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

Multiple String

C

August Wilhelmj

10ArrangerPartyId

The PartyId(s) of the Arranger(s)

Multiple PartyID(s)OISNI::0000000081266409
11MusicPublisher

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


Multiple StringCUMP
12MusicPublisherPatryId

The PartyID(s) of the MusicPublisher(s).

Multiple PartyIDOISNI::00000000111111111
13

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

14WorkContributorPartyId

The PartyId(s) of the WorkContributor(s)

Multiple PartyID(s)OISNI::0000000081266409
15

DataProvider

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

String

O

UMG


 5.5.2 MW01.01 – Basic Musical Work Record With Proprietary ID
This Record Type is an update to the MW01 Record Type defined above and has the same structure as MW01, albeit with two differences:
  • The RecordType shall contain the string MW01.01, instead of MW01; and
  • The following Cell will appear in addition, and to the right of, the Cells defined above.

 

Additional Cell NameField DefinitionData TypeM/O/C?Example
16

ProprietoryWorkId

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

String::String

O

myns::4534

  

 5.5.3 CU01 – Basic Cue Record
This Record provides details about Cues of Creations used in video Resources that are part of an audio-visual Release.

All conditional elements are mandatory when available to the MessageSender.

 

Cell NameField DefinitionData TypeM/O/C?Example
1

RecordType

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

Fixed string

M

CU01

2

BlockId

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

String

M

7

3

CueResourceReference

The Identifier (specific to the Block) of the Record describing the Resource for which the Cue is reported reported.

String

M

4

4

CueStartTime

The start time of the referenced Creation, measured from the start of the Resource from which the CueSheet is referenced (using the ISO 8601:2004 PT[[hhH]mmM]ssS format.

ISO duration

O

PT2M4S

5

CueDuration

The Duration of the use of the referenced Creation (using the ISO 8601:2004 PT[[hhH]mmM]ssS format

ISO duration

M

MP5S

6

ReferencedCreationISRC

The ISRC of the referenced Creation

String

C

USEPW1000164

7

ReferencedCreationISWC

The ISWC of the referenced Creation

String

C

T9100085652

8

ReferencedCreationTitle

The Title of the referenced Creation

String

C

The History of Everything

9

ReferencedCreationDisplayArtistName

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

Multiple Strings

O

Johnny Galecki|Jim Parsons|Kaley Cuoco

10

ReferencedCreationDisplayArtistPartyId

The PartyId of the ReferencedCreation-DisplayArtistName

Multiple PartyID

O

ISNI::0000000081266409|ISNI::0000000012345649|

11

ReferencedCreationCrontributorName

The Name of a contributor of the referenced Creation. If it is a Musical Work, this may be the publisher. This Cell can also be used for a creative contributor when the MessageSender does not know the contributor’s role.

Multiple Strings

O

Johnny Galecki|Jim Parsons|Kaley Cuoco

12

ReferencedCreationCrontributorPartyId

The PartyId of the ReferencedCreation-Crontributor

Multiple PartyID

O

ISNI::0000000081266409|ISNI::0000000012345649|

13

ReferenceCreationComposerAuthorName

The Name of a creative Contributor of the referenced Creation

Multiple Strings

O

Johnny Galecki|Jim Parsons|Kaley Cuoco

14

ReferenceCreationComposerAuthorPartyId

The PartyId of the ReferenceCreation-ComposerAuthor

Multiple PartyID

O

ISNI::0000000081266409

15

ReferenceCreationArrangerName

The Name of a Arranger of the referenced Creation

Multiple Strings

O

Johnny Galecki|Jim Parsons|Kaley Cuoco

16

ReferenceCreationArrangerPartyId

The PartyId of the ReferenceCreationArranger

Multiple PartyID

O

ISNI::0000000081266409


 5.6 Record Types to provide Sales and/or Usage Data

 5.6.1 SU01 – Usage, Revenue or Sales Record for Download Services
This is the Record to communicate Usages, Revenues or Sales of Releases and/or Resources for download services or other similar services.

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 (but not both).

 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.

Cell NameField DefinitionData TypeM/O/C?Example
1

RecordType

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

Fixed string

M

SU01

2

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

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

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

5

TransactedRelease

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

String

C

2345

6TransactedResourceThe Block-specific ReleaseReference of the Record describing the Resource whose Usages, Revenues or Sales are being reported.StringC2345
7

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

8

SalesUpgrade

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

Boolean

M

false

9

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

10

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

11

PriceConsumerPaidExcSalesTax

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

Float

C

100.34

12

PromotionalActivity

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

String

O

Valentines Day Special

 5.6.2 SU02 – Usage, Revenue or Sales Record for Streaming Services and Webcasts
This is the Record to communicate Usages, Revenues or Sales of Releases and/or Resources for streaming services or other similar services.

PriceConsumer-PaidExcSalesTax is mandatory when the CommercialModel  is PayAsYouGoModel. Currency is Mandatory when one financial field is provided.   Either a TransactedRelease or a TransactedResource must be provided (but not both).

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.

 

Cell NameField DefinitionData TypeM/O/C?Example
1

RecordType

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

Fixed string

M

SU02

2

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

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

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

5

TransactedRelease

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

String

C

2345

6TransactedResourceThe Block-specific ReleaseReference of the Record describing the Resource whose Usages, Revenues or Sales are being reported.StringC2345
7

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

O

true

8

NumberOfStreams

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

Integer

M

1000

9

PriceConsumerPaidExcSalesTax

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

Float

C

100.34

10

PromotionalActivity

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

String

O

Valentines Day Special


 

 5.6.3 SU03 – UGC Sales and Usage Record
This is the Record to communicate Usages, Revenues or Sales of UGC Resources.

 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.

 

Cell NameField DefinitionData TypeM/O/C?Example
1

RecordType

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

Fixed string

M

SU03

2

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

3

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

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

DspReleaseId

The ProprietaryIdentifier of the UGC Release assigned by the MessageSender

String

M

12345

6

Usages

The number of times the “Head” Resource or Work has been used in the sales period covered by the Sales Report Message

Integer

C

400

7

NetRevenue

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

Float

M

10545.12

8

ValidityPeriodStart

The first date at which, to the knowledge of the MessageSender, the information provided in the RighsController and RightShare% Cells is accurate.

Note: the ValidityPeriodStart may be earlier (or later) than the first day covered by the sales/usage report.

ISO date

O

2015-06-01

9

ValidityPeriodEnd

The last date at which, to the knowledge of the MessageSender, the information provided in the RighsController and RightShare% Cells is accurate.

Note: the ValidityPeriodEnd may be later (or earlier) than the latest day covered by the sales/usage report.

ISO date

O

2015-06-15

 5.6.4 SU03.01 – UGC Sales and Usage Record (with conditional SummaryRecordId)
This is the Record to communicate Usages, Revenues or Sales of UGC Resources where there is no need to point to a Summary Record. In some cases, a SU03.01 record is followed by a more specific, typically Licensor-specific, Sales/Usage Record.

The sequence of the SU03.01 Record Type is the same as SU03 defined above. However the SummaryRecordId Cell is Conditional:

  • It must not be provided if the SU03.01 Record is followed by a more specific, typically Licensor-specific, Sales/Usage Record (where a SummaryRecordId is provided).
  • It must be provided if the SU03.01 Record is not followed by a more specific, typically Licensor-specific, Sales/Usage Record (where a SummaryRecordId is provided).

 

 

 5.6.5 SU04 – AV-specific Usage Record
Basic sales/usage Record for audio-visual sales/usages.             

PriceConsumerPaidExcSalesTax is mandatory when the CommercialModelType is PayAsYouGoModel.

OriginalBroadcastChannel and OrigialBroadcastDateTime are mandatory for services deemed to be “catch-up” television or streaming. All other conditional Cells are mandatory when available to the MessageSender and they have an impact on licensing terms.   Either a TransactedRelease or a TransactedResource must be provided (but not both).

 

Cell NameField DefinitionData TypeM/O/C?Example
1

RecordType

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

Fixed string

M

SU04

2

BlockId

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

String

M

34

3

SummaryRecordId

The Identifier (specific to the Message) of the Summary Record

that this Usage, Revenue or Sales Record provides details for.

String

M

7

4

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

5

TransactedRelease

The Block-specific ReleaseReference of the Record describing the Release (either a Head Release or a SubRelease) whose  usages, Revenues or Sales are being reported.

String

C

2345

6

TransactedResource

The Block-specific ReleaseReference of the Record describing the Resource whose  usages, Revenues or Sales are being reported.

String

C

2345

7

DrmEnforcementType

The Type of DRM enforcement to indicate if the Release was technically protected.

AVS

C

NotDrmEnforced

8

VideoDefinitionType

The type of resolution (or definition) in which a Video is provided

AVS

C

HighDefinition

9

CodingType

The type of coding in which a Video is provided.

AVS

C

Lossless

10

BitRate

BitRate for the audiovisual data in Mbps

Float

C

1.25

11

OriginalBroadcastChannel

The broadcast channel on which the Release was originally broadcast

String

C

BBC One

12

OriginalBroadcastDateTime

The date and, if available, time, of the original broadcast of the Resource in ISO 8601 format

ISO 8601

C

1999-10-27T20:00:00Z

13

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

14

SalesUpgrade

A Flag indicating whether the SalesTransaction applies to an upgraded Release or not

Boolean

M

false

15

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

Float

M

1000

16

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

17

DurationUsed

The total Duration of the Release that has been used (this may be less than the total Duration of the )Release or Resource (using the ISO 8601:2004 PT[[hhH]mmM]ssS format).

ISO duration

O

PT2M50S

18

PriceConsumerPaidExcSalesTax

A Price paid by Consumers, excluding SalesTax for each

SalesTransaction. This may be a nominal price.

Float

O

100.34

19

PromotionalActivity

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

String

O

Valentines Day Special

20

OfferStartDate

The date on which the Release transacted was made available to consumers.

ISO Date

O

2015-01-01

21

OfferEndDate

The date on which the Release transacted ceased to be  available to consumers.

ISO Date

O

2015-01-12

22

OfferURL

The URL from where the Release transacted was available

String

O

http:/xxx.com/1234

5rgs

 5.6.6 SU05 – Usage, Revenue or Sales Record for Broadcasts
This is the Record to communicate Usages, Revenues or Sales of Releases and/or Resources for broadcasting 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 SY08 that the Sales/Usage Record points to through its SummaryRecordId Cell. The same applies to the broadcast channel used to disseminate the Release/Resources.

 

Cell NameField DefinitionData TypeM/O/C?Example
1

RecordType

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

Fixed string

M

SU05

2

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

3

SummaryRecordId

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

String

M

34

4

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

5

TransactedResource

The Block-specific ResourceReference of the Record describing the Resource whose Usages, Revenues or Sales are being reported. [A previous version erroneously referenced a ReleaseReference.]

String

M

2345

6

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

7

NumberOfBroadcasts

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

Integer

M

1000

8

NumberOfBroadcastListeners

The number of listeners to these Broadcasts.

Integer

O

10000

9

ListenerDuration

The Duration that the SoundRecording has been listened to as part of the Broadcast (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).

DurationOPT1H5M66S
 5.6.7 RU01 - UGC Release Usage Summary Record
The UGC Release Usage Summary Record can be used to provide a summary of the Uses of up to 100 uses of UGC Releases.

 

Cell NameField DefinitionData TypeM/O/C?Example
1

RecordType

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

Fixed string

M

RU01

2

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

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

DspReleaseId

The ProprietaryIdentifier of the UGC Release assigned by the MessageSender

Multiple Strings

M

12345|12346

5

Usages

The number of times the UGC Release has been used in the sales period covered by the Sales Report Message.

Multiple Integer

M

400|655

 5.6.8 RU02 – UGC Release Usage Record
The UGC Release Usage Record can be used to provide details of the Uses of a single UGC Release with title and URL of the Resource.

 

Cell NameField DefinitionData TypeM/O/C?Example
1

RecordType

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

Fixed string

M

RU02

2

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

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

DspReleaseId

The ProprietaryIdentifier of the UGC Release assigned by the MessageSender

String

M

12345

5

ReleaseTitle

The Title of the UGC Release, as given by the user who uploaded the UGC Release

String

M

I am singing in the shower

6

ReleaseURL

The URL from which the MessageSender made the UGC Release available to Consumers

String

M

http://test.te/view/1234

7

Usages

The number of times the “Head” Resource or Work has been used in the sales period covered by the Sales Report Message

Integer

M

400

 5.6.9 LI01 – Licensor-specific Usage Data Record
This Record can be used to communicate UGC Sales/Usage Record to a RightsController to allow provision of revenue and amounts due to individual RightsControllers.

 

Cell NameField DefinitionData TypeM/O/C?Example
1

RecordType

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

Fixed string

M

LI01

2

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

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

RightsController

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

String

M

SACEM

5RightsControllerPartyIdThe PartyId of the RightsControllerPartyIDOISNI::0000000081266409
6

RightsControllerWorkId

The ProprietaryId given to the MusicalWork used by the RightsContoller

String

O

12gc

7

RightShare%

Percentage of the Musical Works used in the Head Resource (or the Head Work itself) that is believed by the MessageSender to be controlled by the RightsController. A quarter share is represented by “25” (and not 0.25).

Float

M

25

8RightsTypeThe right for which the RightShare% is providedAVSOMechanicalRight
9

AllocatedNetRevenue

Net Revenue of generated by the DSP that is to be ascribed to the Head Resource of Work allocated to the RightShare% to the RightsController

Float

M

34567

10

AllocatedAmount

The amount due to the RighsController for the Uses, Revenue or Sales as reported in this Block

Float

M

2560.77

 5.6.10 LI01.01 – Licensor-specific Usage Data Record (with conditional SummaryRecordId)
This Record is an update to the LI01 record and makes the SummaryRecordId conditional as follows:
  • The SummaryRecordId must not be provided if the LI01.01 Record is directly preceded by a SU03.01 Record which contains a SummaryRecordId.
     
  • The SummaryRecordId must be provided if the LI01.01 Record is not directly preceded by a SU03.01 Record or where it is directly preceded by a SU03.01 Record which does not contain a SummaryRecordId. 

 

Cell NameField DefinitionData TypeM/O/C?Example
3SummaryRecordIdThe Identifier (specific to the Message) of the Summary Record that this Usage, Revenue or Sales Record provides details for.
StringC34

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.