DDEX Standard

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.

Older versions of this standard can be accessed 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.

Version 1.1 augments a series of Record Types to cater for updates to Parts 3, 4 and 5.

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.


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 ServiceDescription shall only be used if it aids the MessageRecipient in determining the sales context(s) of the Message.

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.

RepresentedRepertoire is of value only if the sales/usage report is sent to a collective rights management organisation.

Multiple strings

O

GEMA|PAECOL

 



[1] Mandatory – Optional – Conditional

 5.1.2 FOOT – Footer Record
This is the Footer Record for all Multi-Record Block Variant sales/usage reports 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.


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.

NumberOfLinesInReport is only mandatory in the last file of a Sales Report Message.

Integer

C

1234

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

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

NumberOfBlocksInReport is only mandatory in the last file of a Sales Report Message.

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.

 

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
3DistributionChannel

The Party that generated the sales/usages reported in this Sales/Usage Report.

DistributionChannel needs to be provided if the Message Sender offers multiple distribution channels that need to be differentiated in this Sales/Usage Report.

StringCMyCo
4DistributionChannelDPID

The DDEX Party ID of the DistributionChannel.

DistributionChannelDPID shall be provided when essential to the commercial relationship being reported on.

DPIDCDPIDA12345SDF
5CommercialModel

The Type of CommercialModel of the SalesTransaction. The CommercialModel defines how a Consumer has paid for access to a Service or Release/Resource.

AVSMPayAsYouGoModel
6UseType

The nature of a Service as used by a Consumer. This also allows the communication of Device Usages (that is, which type of device a consumer was using to access the Release/Resource) by using the appropriate use type “UseAsDevice”.

AVSMPermanentDownload
7Territory

The Territory for which the Sale/Usage is reported.

AVSMDE
8ServiceDescription

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

ServiceDescription shall be provided if a Message Sender offers multiple services that need to be differentiated in this sales/usage report.

StringCPremiumService
9Usages

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

The Releases or Resources to be reported here are those controlled by the MessageRecipient/RightsController, according to the knowledge of the MessageSender at the time of sending the message.

IntegerM123554
10Subscribers

The number of subscribers to a Service.

Subscribers shall only be provided when the service is based on subscriptions.

Decimal

C12345
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 Releases or Resources, as well as sales of products based on Releases or Resources.

Decimal

M223345.12
13IndirectNetRevenue

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

IndirectNetRevenue shall only be provided when indirect revenues were generated.

Decimal

C13424.50

 5.2.2 SY01.01 – Basic Summary Record (with Exchange Rate)
This Record Type is an update to the SY01 Record Type defined in above and has the same structure as SY01, albeit with two differences:
  • The RecordType shall contain the string SY01.01, instead of SY01; and
  • The following Cell will appear in addition, and to the right of, the Cells defined in SY01:
Additional Cell NameField DefinitionData TypeM/O/C?Example
14ExchangeRateBaseCurrencyThe currency in which the revenue has to be reported.AVSOUSD
15ExchangeRate

The Exchange rate used to convert from the currency used for the transactions into the currency of reporting.

Decimal

O

1.205648

 5.2.3 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
3DistributionChannel

The Party that generated the sales/usages reported in this Sales/Usage Report.

DistributionChannel needs to be provided if the Message Sender offers multiple distribution channels that need to be differentiated in this Sales/Usage Report.

StringCMyCo
4DistributionChannelDPID

The DDEX Party ID of the DistributionChannel.

DistributionChannelDPID shall be provided when essential to the commercial relationship being reported on.  

DPIDCDPIDA12345SDF
5

CommercialModel

The Type of CommercialModel of the SalesTransaction. The CommercialModel defines how a Consumer has paid for access to a Service or Release/Resource.

AVS

M

AdvertisementSupportedMode

6

UseType

The nature of a Service as used by a Consumer. This also allows the communication of Device Usages (that is, which type of device a consumer was using to access the Release/Resource) by using the appropriate use type “UseAsDevice”.

AVS

M

Stream

7

Territory

The Territory for which the Sale/Usage 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 provided to Consumers, including any sales adjustments. Sales adjustments include e.g. file failures.

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 DSP generated from the distribution of Releases or Resources, as well as sales of products based on Releases or Resources.

Decimal

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 Decimals

O

411.29

16

AllocatedRevenue

The amount allocated to the MessageRecipient/RightsController for the usages reported.

This is sometimes called Amount Payable.

Multiple Decimals

O

20.45

17

AllocatedNetRevenue

Net Revenue generated that is to be allocated to the MessageRecipient/RightsController.

Decimal

O

781.73

 5.2.4 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.5 SY02.02 – Summary Record for Ad-Supported and Interactive Streaming Services (with RightsType and ContentCategory)
This Record Type is an update to the SY02.01 Record Type defined in above and has the same structure as SY02.01, albeit with two differences:
  • The RecordType shall contain the string SY02.02, instead of SY02.01;
  • The following Cell will appear in addition, and to the right of, the Cells defined in SY02.01:
Additional Cell NameField DefinitionData TypeM/O/C?Example
19

ContentCategory

A string categorising the content that has been used or distributed as agreed between sender and recipient.

StringMMusic
20ExchangeRateBaseCurrencyThe currency in which the revenue has to be reported.AVSOUSD
21ExchangeRate

The Exchange rate used to convert from the currency used for the transactions into the currency of reporting.

Decimal

O

1.205648

22RightsTypePercentage

The percentage of how much of the revenue or royalties should be allocated to the RightsType communicated in Cell 18.

The RightsTypePercentage may only be provided if a RightsType is provided. For the avoidance of doubt, it is permissable to communicate a RightsType without a RightsTypePercentage.

 Cells 9 (Usages), 10 (Users) and 12 (NetRevenue) shall be provided not pro-rated by the RightsTypePercentage, i.e. if a RightsType only attracts 25% of the royalties, 100% of these values shall be reported in the respective Cells.

DecimalC10.00

 5.2.6 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
3DistributionChannel

The Party that generated the sales/usages reported in this Sales/Usage Report.

DistributionChannel needs to be provided if the Message Sender offers multiple distribution channels that need to be differentiated in this Sales/Usage Report.

StringCMyCo
4DistributionChannelDPID

The DDEX Party ID of the DistributionChannel

DistributionChannelDPID needs to be provided if the Message Sender offers multiple distribution channels that need to be differentiated in this Sales/Usage Report.

DPIDCDPIDA12345SDF
5

CommercialModel

The Type of CommercialModel of the SalesTransaction. The CommercialModel defines how a Consumer has paid for access to a Service or Release/Resource.

AVS

M

SubscriptionModel

6

UseType

The nature of a Service as used by a Consumer. This also allows the communication of Device Usages (that is, which type of device a consumer was using to access the Release/Resource) by using the appropriate use type “UseAsDevice”.

AVS

M

Stream
7

Territory

The Territory for which the Sale/Usage 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 provided to Consumers, including any sales adjustments. Sales adjustments include e.g. file failures.

 

Integer

M

1234

10

Subscribers

The number of subscribers to a Service.

Decimal

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 DSP generated from the distribution of Releases or Resources, as well as sales of products based on Releases or Resources.

Decimal

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 inAllocatedUsages and AllocatedRevenue shall be the same so that the recipient is able to relate figures correctly.

Multiple Decimals

O

411.29

16

AllocatedRevenue

The amount allocated to the MessageRecipient/RightsController for the usages reported.

This is sometimes called Amount Payable.

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 Decimals

O

20.45

17

AllocatedNetRevenue

Net Revenue generated that is to be allocated to the MessageRecipient/RightsController.

Decimal

O

781.73

18

RightsControllerMarketShare

The ratio in percent between Usages and AllocatedUsages.

Decimal

O

18.25

19

ConsumerPaidUnitPrice

The average price paid by the Subscribers

Decimal

M

6.62

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

Decimal

M

1239867

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

ExchangeRate

The Exchange rate used to convert from the currency used for the transactions into the currency of reporting.

Decimal

O

1.205648

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

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 Party that generated the sales/usages reported in this Sales/Usage Report.

DistributionChannel needs to be provided if the Message Sender offers multiple distribution channels that need to be differentiated in this Sales/Usage Report.

String

C

MyCo

4

DistributionChannelDPID

The DDEX Party ID of the DistributionChannel.

DistributionChannelDPID shall be provided when essential to the commercial relationship being reported on.

DPID

C

DPIDA12345SDF

5

CommercialModel

The Type of CommercialModel of the SalesTransaction. The CommercialModel defines how a Consumer has paid for access to a Service or Release/Resource.

AVS

M

SubscriptionModel

6

UseType

The nature of a Service as used by a Consumer. This also allows the communication of Device Usages (that is, which type of device a consumer was using to access the Release/Resource) by using the appropriate use type “UseAsDevice”.

AVS

M

Stream

7

Territory

The Territory for which the Sale/Usage 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 to a Service for each SubscriberType.

Decimal

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 in a more granular form than for the overall reporting period. This is a string with the syntax YYYY[-MM[-DD]].

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

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 in a more granular form than for the overall reporting period. This is a string with the syntax YYYY[-MM[-DD]].

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.

The ReportingSubPeriodEndDate must not be later than than the UsageEndDate provided in the relevant header record and must not be earlier than the ReportingSubPeriodStartDate

Date

C

2014-12-01

13

UsagesInSubPeriod

The number of Usages of the Release or Resource provided to Consumers, including any sales adjustments in the sub period. Sales adjustments include e.g. file failures.

UsagesInSubPeriod and UsagesInReportingPeriod are conditional depending on the commercial relationship between Message Sender and Message Recipient.

Integer

C

1234

14

UsagesInReportingPeriod

The number of Usages of the Release or Resource provided to Consumers, including any sales adjustments in the overall reporting period. Sales adjustments include e.g. file failures.

UsagesInSubPeriod and UsagesInReportingPeriod are conditional depending on the commercial relationship between Message Sender and Message Recipient.

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 from the currency used for the transactions into the currency of reporting.

Decimal

O

1.205648

18

ConsumerPaidUnitPrice

The average price paid by the Subscribers

Decimal

M

6.62

19

NetRevenue

Net Revenue of the DSP generated from the distribution of Releases or Resources, as well as sales of products based on Releases or Resources.

Decimal

M

10545.12


 5.2.8 SY04.01 — Per-subscriber Minima Summary Record for Subscription Services with Ratio
This Record Type is an update to the SY04 Record Type defined above and has the same structure as SY04, albeit with two differences:
  • The RecordType shall contain the string SY04.01, instead of SY04; and
  • The following Cell will appear in addition, and to the right of, the Cells defined in SY04.
Additional Cell NameField DefinitionData TypeM/O/C?Example
20

MusicUsagePercentage

The percentage of musical content in the subscription service.

Decimal between 0 and 100

M

14.54

 5.2.9 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 Decimal

O

411.29

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

AllocatedNetRevenue

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

Multiple Decimals

O

20.45

16

AllocatedRevenue

The amount allocated to the MessageRecipient/RightsController for the usages reported.

This is sometimes called Amount Payable.

Decimal

O

781.73

17

RightsControllerMarketShare

The ratio in percent between TotalUsages and AllocatedUsages

Decimal

O

18.25


 5.2.10 SY05.01 – Licensor Usage and Revenue Summary Record for Subscription Services with Currency and SubPeriods
This Record Type is an update to the SY05 Record Type defined above and has the same structure as SY05, albeit with two differences:
  • The RecordType shall contain the string SY05.01, instead of SY05; and
  • The following Cell will appear in addition, and to the right of, the Cells defined in SY05.
Additional Cell NameField DefinitionData TypeM/O/C?Example
18

Currency

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

AVS

O

EUR

19ExhangeRateBaseCurrenty

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

AVSOCHF
20ExchangeRate

The Exchange rate used to convert from the currency used for the transactions into the currency of reporting.

Decimal

O1.23
21

SubscriberType

The type of Subscriber.

String

O

Student

22SubPeriodStartDate

Start of the SubPeriod, the meaning of which is agreed between Sender and Recipient.

DateO2015-01-01
23SubPeriodEndDate

End of the SubPeriod, the meaning of which is agreed between Sender and Recipient.

DateO2015-10-01

 5.2.11 SY05.02 – Licensor Usage and Revenue Summary Record for Subscription Services (with Currency, SubPeriods and ContentCategory)
This Record Type is an update to the SY05.01 Record Type defined above and has the same structure as SY05.01, albeit with two differences:
  • The RecordType shall contain the string SY05.02, instead of SY05.01; and
  • The following Cell will appear in addition, and to the right of, the Cells defined in SY05.01.
Additional Cell NameField DefinitionData TypeM/O/C?Example
24

ContentCategory

A string categorising the content that has been used or distributed as agreed between sender and recipient.StringMMusic
25RightsTypePercentage

The percentage of how much of the revenue or royalties should be allocated to the RightsType communicated in Cell 11.

The RightsTypePercentage may only be provided if a RightsType is provided. For the avoidance of doubt, it is permissable to communicate a RightsType without a RightsTypePercentage.

 Cell 12 (TotalUsages) shall be provided not pro-rated by the RightsTypePercentage, i.e. if a RightsType only attracts 25% of the royalties, 100% of this value shall be reported in Cell 12.

DecimalC10.00

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

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 Party that generated the sales/usages reported in this Sales/Usage Report.

DistributionChannel needs to be provided if the Message Sender offers multiple distribution channels that need to be differentiated in this Sales/Usage Report.

String

C

MyCo

4

DistributionChannelDPID

The DDEX Party ID of the DistributionChannel

DistributionChannelDPID is mandatory when available to the MessageSender. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

DPID

C

DPIDA12345SDF

5

CommercialModel

The Type of CommercialModel of the SalesTransaction. The CommercialModel defines how a Consumer has paid for access to a Service or Release/Resource.

AVS

M

PayAsYouGoModel

6

UseType

The nature of a Service as used by a Consumer. This also allows the communication of Device Usages (that is, which type of device a consumer was using to access the Release/Resource) by using the appropriate use type “UseAsDevice”.

AVS

M

PermanentDownload

7

Territory

The Territory for which the Sale/Usage 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

Purchase

 

9

Usages

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

Integer

M

123554

10

Subscribers

The number of subscribers to a Service.

Subscribers shall only be provided when the service is based on subscriptions.

Decimal

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

Integer

O

64

13

NetRevenue

Net Revenue of the DSP generated from the distribution of Releases or Resources, as well as sales of products based on Releases or Resources.

Decimal

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.

IndirectNetRevenue shall only be provided when indirect revenues were generated.

Decimal

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.13 SY06.01 – Summary Record for AV Content (with Exchange Rate Information)
This Record Type is an update to the SY06 Record Type defined above and has the same structure as SY06, albeit with two differences:
  • The RecordType shall contain the string SY06.01, instead of SY06; and
  • The following Cells will appear in addition, and to the right of, the Cells defined in SY06.
Additional Cell NameField DefinitionData TypeM/O/C?Example
16

ExchangRateBaseCurrency

Currency used for consumer-based financial information (represented by an ISO 4217 CurrencyCode).

AVS

O

EUR

17ExchangeRateThe Exchange rate used to convert from the currency used for the transactions into the currency of reporting.DecimalO1234

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

 

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 Party that generated the sales/usages reported in this Sales/Usage Report.

DistributionChannel needs to be provided if the Message Sender offers multiple distribution channels that need to be differentiated in this Sales/Usage Report.

String

C

MyCo

4

DistributionChannelDPID

The DDEX Party ID of the DistributionChannel.

DistributionChannelDPID shall be provided when applicable in the relevant business relationship.

DPID

C

DPIDA12345SDF

5

CommercialModel

The Type of CommercialModel of the SalesTransaction. The CommercialModel defines how a Consumer has paid for access to a Service or Release/Resource.

AVS

O

PayAsYouGoModel

6

UseType

The nature of a Service as used by a Consumer. This also allows the communication of Device Usages (that is, which type of device a consumer was using to access the Release/Resource) by using the appropriate use type “UseAsDevice”.

UseType shall be provided when applicable in the relevant business relationship.

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. The ServiceDescription may not contain space characters or underscores.

String

O

PremiumService

10

Usages

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

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 DSP generated from the distribution of Releases or Resources, as well as sales of products based on Releases or Resources.

NetRevenue shall be provided when applicable in the relevant business relationship.

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 Decimals

O

123.2

17

AllocatedRevenue

The amount allocated to the MessageRecipient/RightsController for the usages reported.

This is sometimes called Amount Payable.

Decimal

M

234.12

18

AllocatedNetRevenue

Net Revenue generated that is to be allocated to the MessageRecipient/RightsController.

Decimal

M

12.99

 5.2.15 SY07.01 – Summary Record for Royalty Reports (with Exchange Rate Information)
This Record Type is an update to the SY07 Record Type defined above and has the same structure as SY07, albeit with two differences:
  • The RecordType shall contain the string SY07.01, instead of SY07; and
  • The following Cell will appear in addition, and to the right of, the Cells defined in SY07.
Additional Cell NameField DefinitionData TypeM/O/C?Example
19

ExchangRateBaseCurrency

Currency used for consumer-based financial information (represented by an ISO 4217 CurrencyCode).

AVS

O

EUR

20ExchangeRateThe Exchange rate used to convert from the currency used for the transactions into the currency of reporting.DecimalO1234
21RightsTypePercentage

The percentage of how much of the revenue or royalties should be allocated to the RightsType communicated in Cell 8.

The RightsTypePercentage may only be provided if a RightsType is provided. For the avoidance of doubt, it is permissable to communicate a RightsType without a RightsTypePercentage.

Cells 10 (Usages), 11 (Users) and 13 (NetRevenue) shall be provided not pro-rated by the RightsTypePercentage, i.e. if a RightsType only attracts 25% of the royalties, 100% of these values shall be reported in the respective Cells.

DecimalC10.00

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

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 Party that generated the sales/usages reported in this Sales/Usage Report.

DistributionChannel needs to be provided if the Message Sender offers multiple distribution channels that need to be differentiated in this Sales/Usage Report.

String

C

MyCo

4

DistributionChannelDPID

The DDEX Party ID of the DistributionChannel.

DistributionChannelDPID shall be provided when applicable in the relevant business relationship.

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 defines how a Consumer has paid for access to a Service or Release/Resource.

AVS

M

AdvertisementSupportedModel

8

UseType

The nature of a Service as used by a Consumer. This also allows the communication of Device Usages (that is, which type of device a consumer was using to access the Release/Resource) by using the appropriate use type “UseAsDevice”.

AVS

M

Broadcast

9

Territory

The Territory for which the Sale/Usage 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.

Decimal

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.

Decimal

M

565.86

15

IndirectNetRevenue

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

IndirectNetRevenue shall be provided when applicable in the relevant business relationship.

Decimal

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

PartyID

O

ISNI::0000000081266409

18

AllocatedRevenue

The amount allocated to the MessageRecipient/RightsController for the usages reported.

This is sometimes called Amount Payable.

Decimal

O

102.09

19

RightsType

The right utilised in broadscating the Resource.

A RightsType shall be provided when it applies to the broadcast Resource.

AVS

C

MechanicalRight

20

AllocatedNetRevenue

The amount allocated to the MessageRecipient/RightsController for the Usages reported.

Decimal

O

19.11

21

RightsControllerAllocatedNumberOfBroadcasts

Number of broadcasts pro rated for the RightsController

Decimal

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.2.17 SY08.01 – Summary Record for Broadcast Reports (with Exchange Rate Information)
This Record Type is an update to the SY08 Record Type defined above and has the same structure as SY08, albeit with two differences:
  • The RecordType shall contain the string SY08.01, instead of SY08; and
  • The following Cells will appear in addition, and to the right of, the Cells defined in SY08.
Additional Cell NameField DefinitionData TypeM/O/C?Example
23

ExchangRateBaseCurrency

Currency used for consumer-based financial information (represented by an ISO 4217 CurrencyCode).

AVS

O

EUR

24ExchangeRateThe Exchange rate used to convert from the currency used for the transactions into the currency of reporting.DecimalO1234
25RightsTypePercentage

The percentage of how much of the revenue or royalties should be allocated to the RightsType communicated in Cell 19.

The RightsTypePercentage may only be provided if a RightsType is provided. For the avoidance of doubt, it is permissable to communicate a RightsType without a RightsTypePercentage.

 Cell 14 (NetRevenue) shall be provided not pro-rated by the RightsTypePercentage, i.e. if a RightsType only attracts 25% of the royalties, 100% of this value shall be reported in that Cell.

DecimalC10.00

 5.2.18 SY09 – Summary Record to communicate Rights Controller Market Shares
This is the Record to communicate market-shares per right type for individual rights controllers.

Cell Name

Field Definition

Data Type

M/O/C

Example

1

RecordType

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

Fixed String

M

SY09

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 Rights Controller they provide details.

String

M

123

3

CommercialModel

The Type of CommercialModel of the SalesTransaction. The CommercialModel defines how a Consumer has paid for access to a Service or Release/Resource.

AVS

M

AdvertisementSupportedModel

4UseType

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

AVSMStream
5

Territory

The Territory for which the Sale/Usage is reported.

AVS

M

DE

6

ServiceDescription

The service name (e.g. a service tier) under which the SalesTransaction took place. The ServiceDescription may not contain space characters or underscores.
ServiceDescription shall be provided when essential to the commercial relationship being reported on.

StringCPremiumService
7SubscriberType

The type of Subscriber.

SubscriberType needs to be provided if the sales report covers subscriptions.

StringCStudent
8

RightsController

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

String

O

SACEM

9

RightsControllerPartyID

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

PartyID

O

ISNI::0000000081266409

10

RightsType

The right utilised in broadscating the Resource.

A RightsType shall be provided when it applies to the broadcast Resource.

AVS

C

MechanicalRight

11

TotalUsages

The number of Usages of the Release or Resource provided to Consumers, including any sales adjustments. Sales adjustments include e.g. file failures. Releases or Resources to be reported here include all Releases or Resources provided across the service, not just the ones that are are controlled by the MessageRecipient/RightsController, according to the knowledge of the MessageSender at the time of sending the message. This allows the MessageRecipient/RightsController to calculate its market share of uses.
TotalUsages shall be provided when essential to the commercial relationship being reported on.

TotalUsages shall be provided not pro-rated by the RightsTypePercentage, i.e. if a RightsType only attracts 25% of the royalties, 100% of this value shall be reported in that Cell.

DecimalC1066.45
12AllocatedUsages

The number of Usages allocated to the RightsController.

DecimalO135.23
13NetRevenue

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

NetRevenue shall be provided not pro-rated by the RightsTypePercentage, i.e. if a RightsType only attracts 25% of the royalties, 100% of this value shall be reported in that Cell.

DecimalM1220.06
14IndirectNetRevenue

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

DecimalO120.81
15

RightsControllerMarketShare

The ratio in percent between TotalUsages and AllocatedUsages

Decimal

O10.54
16CurrencyCurrency of accountingAVSMCZK
17

ExchangRateBaseCurrency

Currency used for consumer-based financial information (represented by an ISO 4217 CurrencyCode).

AVS

O

EUR

18ExchangeRateThe Exchange rate used to convert from the currency used for the transactions into the currency of reporting.DecimalO1234
19RightsTypePercentage

The percentage of how much of the revenue or royalties should be allocated to the RightsType communicated in Cell 18.

The RightsTypePercentage may only be provided if a RightsType is provided. For the avoidance of doubt, it is permissable to communicate a RightsType without a RightsTypePercentage.

DecimalC10.00

 



 

 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 on whether it is an EAN (13) or a UPC (12). 14 character ICPNs are also permitted.

ICPN is mandatory when available to the MessageSender. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

String

C

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 on whether it is an EAN (13) or a UPC (12). 14 character ICPNs are also permitted.

ICPN is mandatory when available to the MessageSender. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

String

C

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.

SeriesTitle must be provided if the Release is part of a Series.

String

C

The Office

10

SeasonNumber

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

SeasonNumber must be provided if the Release is part of 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.3.4 RE03.01 – Audio-visual Release Record with VideoCategory
This Record Type is an update to the RE03 Record Type defined above and has the same structure as RE03, albeit with two differences:
  • The RecordType shall contain the string RE03.01, instead of RE03; and
  • The following Cell will appear in addition, and to the right of, the Cells defined in RE01.
Additional Cell NameField DefinitionData TypeM/O/C?Example
15

VideoCategory

A description of the content of the video as agreed between sender and recipient to classify the used Release.

String

O

Sport

16EpisodeNumber

The number indicating the order of the Episode within a Season.

EpisodeNumber must be provided if the Episode is part of a Series.

Multiple EpisodeNumbers can be provided when agreed between Message Sender and Message Recipient.

Multiple Integer C 5
17

UserChannelName

The name of channel assigned by a user (individual or company) in which music or videos are made available

String

O

MontreuxComedy

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

ISRC is mandatory when available to the MessageSender. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

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 AS01.01 – Basic Sound Recording Record with MasterRecording Flag
This Record Type is an update to the AS01 Record Type defined above and has the same structure as AS01, albeit with two differences:
  • The RecordType shall contain the string AS01.01, instead of AS01;
  • Cells 5 and 10 are changed as follows:

 

Additional Cell NameField DefinitionData TypeM/O/C?Example
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.

Multiple Strings

C

USS1Z1412345

10Duration

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

The Duration shall be provided if available to the Message Sender.

ISO durationCPT1H2M3S

 

  • The following Cell will appear in addition, and to the right of, the Cells defined in AS01.
Additional Cell NameField DefinitionData TypeM/O/C?Example
12

IsMasterRecording

A flag indicating if the Sound Recording is a "master recording" or not.

IsMasterRecording could be used if, for example, a DSP has to report usage of a sound recording that was uploaded by a user but which is not based on a master recording for which the DSP has received a claim from a record company, the DSP needs to create it’s own sound recording to meet the structural requirements of the DSR standard. However, the DSP also needs to alert the works licensor to not not try to match this sound recording to any other sound recording it may have received from other DSPs as the only purpose of this sound recording is to carry the work information.

Boolean

O

true

The Cell IsMasterRecording is recommended to not be used. Implementers are notified that the Cell may be removed from the DSR Standard at a future date. This applies to all AS01 and AS02 Records.

 5.4.3 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 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
12

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.

ISWC is mandatory when available to the MessageSender. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

String

C

T0030749586

13

ComposerAuthor

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

ComposerAuthor is mandatory when available to the MessageSender. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

The order of the individual strings in ComposerAuthor and ComposerAuthorPartyId shall be the same so that the recipient is able to relate names and IDs correctly

Multiple String

C

Johann Sebastian Bach

14ComposerAuthorPartyId

The PartyId(s) of the ComposerAuthor(s)

The order of the individual strings in ComposerAuthor and ComposerAuthorPartyId shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one ComposerAuthorPartyId can be provided for each ComposerAuthor.

Multiple PartyIDOISNI::0000000081266409
15

Arranger

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

Arranger is mandatory when available to the MessageSender. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

The order of the individual strings in Arranger and ArrangerPartyID shall be the same so that the recipient is able to relate names and IDs correctly.

Multiple String

C

August Wilhelmj

16ArrangerPartyId

The PartyId(s) of the Arranger(s)

The order of the individual strings in Arranger and ArrangerPartyID shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one ArrangerPartyId can be provided for each Arranger.

Multiple PartyIDOISNI::0000000081266409
17MusicPublisher

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

MusicPublisher is mandatory when available to the MessageSender. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

The order of the individual strings in MusicPublisher and MusicPublisherPartyID shall be the same so that the recipient is able to relate names and IDs correctly

Multiple StringCUMP
18MusicPublisherPartyId

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

The order of the individual strings in MusicPublisher and MusicPublisherPartyID shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one MusicPublisherPartyId can be provided for each MusicPublisher.

Multiple PartyIDOISNI::00000000111111111
19

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.

WorkContributor is mandatory when available to the MessageSender unless the contributor has already been included as a ComposerAuthor, Arranger or MusicPublisher. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

The order of the individual strings in WorkContributor and WorkContributorPartyID shall be the same so that the recipient is able to relate names and IDs correctly

Multiple String

C

UMP

20WorkContributorPartyId

The PartyId(s) of the WorkContributor(s)

The order of the individual strings in WorkContributor and WorkContributorPartyID shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one WorkContributorPartyId can be provided for each WorkContributor.

Multiple PartyIDOISNI::0000000081266409

 5.4.4 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
21

ProprietaryWorkId

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

String::String

O

myns::4534

 5.4.5 AS02.02 – 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 albeit with two differences:
  • The RecordType shall contain the string AS02.02, instead of AS02.01; and
  • The AS02.02 Record has the same structure as AS02.01 defined above, with the same additions and rules as defined for AS01.01.

For the avoidance of doubt, the Cells added by AS01.01 shall appear in addition to, and to the right of, the Cells added in AS02.01. As a result, the Cell IsMasterRecording shall appear in position 22.

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

ISAN is mandatory when available to the MessageSender. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

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

EIDR is mandatory when available to the MessageSender. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

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.

OriginalTitle mandatory when available to the MessageSender. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

String

O

The Hamburger Postulate

12

SeasonNumber

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

SeasonNumber has to be provided for seasons of TV series or parts thereof.

Integer

C

1

13

EpisodeNumber

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

EpisodeNumber has to be provided for TV series episodes.

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

The order of the individual strings in ProducerName and ProducerPartyId shall be the same so that the recipient is able to relate names and IDs correctly.

Multiple Strings

O

Scott Kraft

17

ProducerPartyId

The PartyId(s) of the Producer(s)

The order of the individual strings in ProducerName and ProducerPartyId shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one ProducerPartyId can be provided for each ProducerName.

Multiple PartyID

O

ISNI::0000000081266409

18

DirectorName

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

DirectorName is mandatory for films and documentaries when available to the MessageSender. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

The order of the individual strings in DirectorName and DirectorPartyId shall be the same so that the recipient is able to relate names and IDs correctly.

Multiple Strings

C

Mark Cendrowski

19

DirectorPartyId

The PartyId(s) of the Director(s)

The order of the individual strings in DirectorName and DirectorPartyId shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one DirectorPartyId can be provided for each DirectorName.

Multiple PartyID

O

ISNI::0000000081266409

20

ActorName

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

The order of the individual strings in ActorName and ActorPartyId shall be the same so that the recipient is able to relate names and IDs correctly

Multiple Strings

O

Jim Parsons

21

ActorPartyId

The PartyId(s) of the Actor(s)

The order of the individual strings in ActorName and ActorPartyId shall be the same so that the recipient is able to relate names and IDs correctly

Multiple PartyID

O

ISNI::0000000081266409

22

LanguageLocalizationType

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

LanguageOfDubbing is mandatory when LanguageLocalizationType is Dubbed, SubTitled or Multilingual.

AVS

C

Dubbed

23

HasCaptioning

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

HasCaptioning is mandatory when available to the MessageSender. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

Boolean

C

false

24

HasAudioDescription

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

HasAudioDescription is mandatory when available to the MessageSender. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

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

ProductionOrReleaseDate

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

DateOfProductionOrRelease is mandatory when available to the MessageSender. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

ISO date

C

2015

28

CountryOfProduction

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

CountryOfProduction is mandatory when available to the MessageSender. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

Multiple ISO Country Codes

C

GB|IE

 5.4.7 AS03.01 – Audio-visual Resource Record with DateOfFirstVoDBroadcast
This Record Type is an update to the AS03 Record Type defined above and has the same structure as AS03, albeit with two differences:
  • The RecordType shall contain the string AS03.01, instead of AS03; and
  • Cell 13 is changed as follows:
Additional Cell NameField DefinitionData TypeM/O/C?Example
13

EpisodeNumber

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

EpisodeNumber has to be provided for TV series episodes.

Multiple EpisodeNumbers can be provided when agreed between Message Sender and Message Recipient.

Multiple Integer

C

3

  • The following Cell will appear in addition, and to the right of, the Cells defined in AS03
Additional Cell NameField DefinitionData TypeM/O/C?Example
29

FirstVoDBroadcastDate

The date of the first video on demand broadcast of the Resource in the territory (or territories) reported in the Sales/Usage Report in the ISO 8601 format: YYYY[-MM[-DD]].

Date

O

2015-02-05

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

ISWC is mandatory when available to the MessageSender. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

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.

ComposerAuthor is mandatory when available to the MessageSender. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

The order of the individual strings in ComposerAuthor and ComposerAuthorPartyID shall be the same so that the recipient is able to relate names and IDs correctly.

Multiple String

C

Johann Sebastian Bach

8ComposerAuthorPartyId

The PartyId(s) of the ComposerAuthor(s)

The order of the individual strings in ComposerAuthor and ComposerAuthorPartyID shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one ComposerAuthorPartyId can be provided for each ComposerAuthor.

Multiple PartyID(s)OISNI::0000000081266409
9

Arranger

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

Arranger is mandatory when available to the MessageSender. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

The order of the individual strings in Arranger and ArrangerPartyID shall be the same so that the recipient is able to relate names and IDs correctly.

Multiple String

C

August Wilhelmj

10ArrangerPartyId

The PartyId(s) of the Arranger(s)

The order of the individual strings in Arranger and ArrangerPartyID shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one ArrangerPartyId can be provided for each Arranger.

Multiple PartyID(s)OISNI::0000000081266409
11MusicPublisher

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

MusicPublisher is mandatory when available to the MessageSender. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

The order of the individual strings in MusicPublisher and MusicPublisherPartyID shall be the same so that the recipient is able to relate names and IDs correctly.

Multiple StringCUMP
12MusicPublisherPartyId

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

The order of the individual strings in MusicPublisher and MusicPublisherPartyID shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one MusicPublisherPartyId can be provided for each MusicPublisher.

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.

WorkContributor is mandatory when available to the MessageSender unless the contributor has already been included as a ComposerAuthor, Arranger or MusicPublisher. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

The order of the individual strings in WorkContributor and WorkContributorPartyID shall be the same so that the recipient is able to relate names and IDs correctly.

Multiple String

C

UMP

14WorkContributorPartyId

The PartyId(s) of the WorkContributor(s)

The order of the individual strings in WorkContributor and WorkContributorPartyID shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one WorkContributorPartyId can be provided for each WorkContributor.

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

ProprietaryWorkId

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.

 

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.

ReferencedCreationISRC is mandatory when available to the MessageSender. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

String

C

USEPW1000164

7

ReferencedCreationISWC

The ISWC of the referenced Creation.

ReferencedCreationISWC is mandatory when available to the MessageSender. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

String

C

T9100085652

8

ReferencedCreationTitle

The Title of the referenced Creation.

ReferencedCreationTitle is mandatory when available to the MessageSender. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

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.

The order of the individual strings in ReferencedCreationDisplayArtistName and ReferencedCreationDisplayArtistPartyID shall be the same so that the recipient is able to relate names and IDs correctly.

Multiple Strings

O

Johnny Galecki|Jim Parsons|Kaley Cuoco

10

ReferencedCreationDisplayArtistPartyId

The PartyId of the ReferencedCreationDisplayArtistName.

The order of the individual strings in ReferencedCreationDisplayArtistName and ReferencedCreationDisplayArtistPartyID shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one ReferencedCreationDisplayArtistPartyId can be provided for each ReferencedCreationDisplayArtistName.

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.

The order of the individual strings in ReferencedCreationCrontributorName and ReferencedCreationCrontributorPartyID shall be the same so that the recipient is able to relate names and IDs correctly.

Multiple Strings

O

Johnny Galecki|Jim Parsons|Kaley Cuoco

12

ReferencedCreationContributorPartyId

The PartyId of the ReferencedCreationCrontributor.

The order of the individual strings in ReferencedCreationCrontributorName and ReferencedCreationCrontributorPartyID shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one ReferencedCreationContributorPartyId can be provided for each ReferencedCreationContributorName.

Multiple PartyID

O

ISNI::0000000081266409|ISNI::0000000012345649|

13

ReferencedCreationComposerAuthorName

The Name of a creative Contributor of the referenced Creation.

The order of the individual strings in ReferencedCreationComposerAuthorName and ReferencedCreationComposerAuthorPartyId shall be the same so that the recipient is able to relate names and IDs correctly.

Multiple Strings

O

Johnny Galecki|Jim Parsons|Kaley Cuoco

14

ReferencedCreationComposerAuthorPartyId

The PartyId of the ReferencedCreationComposerAuthor.

The order of the individual strings in ReferencedCreationComposerAuthorName and ReferencedCreationComposerAuthorPartyId shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one ReferencedCreationComposerAuthorPartyId can be provided for each ReferencedCreationComposerAuthorName.

Multiple PartyID

O

ISNI::0000000081266409

15

ReferencedCreationArrangerName

The Name of an Arranger of the referenced Creation.

The order of the individual strings in ReferencedCreationArrangerName and ReferencedCreationArrangerPartyId shall be the same so that the recipient is able to relate names and IDs correctly.

Multiple Strings

O

Johnny Galecki|Jim Parsons|Kaley Cuoco

16

ReferencedCreationArrangerPartyId

The PartyId of the ReferencedCreationArranger.

The order of the individual strings in ReferencedCreationArrangerName and ReferencedCreationArrangerPartyId shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one ReferencedCreationArrangerPartyId can be provided for each ReferencedCreationArrangerPartyName.

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.

 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. Taken together with the Message ID this shall be globally and perpetually unique. 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. 

Either a TransactedRelease or a TransactedResource must be provided (but not both).

String

C

2345

6TransactedResource

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

Either a TransactedRelease or a TransactedResource must be provided (but not both).

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 or Resource provided to Consumers, including any sales adjustments. Sales adjustments include e.g. file failures.

Integer

M

1000

10

Returns

The number of Usages of a Release or Resource returned (with refund) by Consumers 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.

PriceConsumerPaidExcSalesTax is mandatory when the CommercialModel is PayAsYouGoModel.

Decimal

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.

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. Taken together with the Message ID this shall be globally and perpetually unique. 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. 

Either a TransactedRelease or a TransactedResource must be provided (but not both).

String

C

2345

6TransactedResource

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

Either a TransactedRelease or a TransactedResource must be provided (but not both).

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.

PriceConsumerPaidExcSalesTax is mandatory when the CommercialModel is PayAsYouGoModel.

Decimal

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 SU02.01 – Usage, Revenue or Sales Record for Streaming Services and Webcasts (updated NumberOfStreams)
This Record Type is an update to the SU02 Record Type defined above and has the same structure as SU02, albeit with two differences:
  • The RecordType shall contain the string SU02.01, instead of SU02; and
  • The datatype of Cell 8, NumberOfStreams, is changed from integer to decimal.

 5.6.4 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. Taken together with the Message ID this shall be globally and perpetually unique. 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 Usages of the “Head” Resource or Work provided to Consumers, including any sales adjustments. Sales adjustments include e.g. file failures.

Integer

C

400

7

NetRevenue

Net Revenue of the DSP generated from the distribution of Releases or Resources, as well as sales of products based on Releases or Resources in the CurrencyOfTransaction.

Decimal

M

10545.12

8

ValidityPeriodStart

 The first date of the validity period as provided by the Licensor for the RightsController and RightShare% Cells.

ISO date

O

2015-06-01

9

ValidityPeriodEnd

The last date of the validity period as provided by the Licensor for the RightsController and RightShare% Cells.

ISO date

O

2015-06-15

 5.6.5 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.6 SU03.02 – UGC Sales and Usage Record (with ContentCategory and IsRoyaltyBearing Flag)
This Record Type is an update to the SU03.01 Record Type defined above and has the same structure as SU03.01, albeit with two differences:
  • The RecordType shall contain the string SU03.02, instead of SU03.01; and
  • Cell 5 is changed from DspReleaseId to DspResourceId and its definition is changed to "The ProprietaryIdentifier of the UGC Resource assigned by the MessageSender"
  • Cell 6 is changed as follows:

 

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

Usages

The number of Usages of the “Head” Resource or Work provided to Consumers, including any sales adjustments. Sales adjustments include e.g. file failures. – The only change between SY03.01 and SU03.02 is the datatype.

Decimal

M

400.25

 

  • The following Cells will appear in addition, and to the right of, the Cells defined in SU03.01.
Additional Cell NameField DefinitionData TypeM/O/C?Example
10

ContentCategory

A string categorising the content that has been used or distributed as agreed between sender and recipient.

String

O

Music

11IsRoyaltyBearing

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

BooleanOtrue

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

 

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. Taken together with the Message ID this shall be globally and perpetually unique. The SalesTransactionId may change when the report is re-generated.

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. 

Either a TransactedRelease or a TransactedResource must be provided (but not both).

String

C

2345

6

TransactedResource

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

Either a TransactedRelease or a TransactedResource must be provided (but not both).

String

C

2345

7

DrmEnforcementType

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

DrmEnforcementType is mandatory when available to the MessageSender and has an impact on licensing terms. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

AVS

C

NotDrmEnforced

8

VideoDefinitionType

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

VideoDefintionType is mandatory when available to the MessageSender and has an impact on licensing terms. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

AVS

C

HighDefinition

9

CodingType

The type of coding in which a Video is provided.

CodingType is mandatory when available to the MessageSender and has an impact on licensing terms. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

AVS

C

Lossless

10

BitRate

BitRate for the audiovisual data in Mbps.

BitRate is mandatory when available to the MessageSender and has an impact on licensing terms. This field is important for MessageRecipients for their processing and would ideally be mandatory in this Standard. However, as there are rare cases where licensees genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”.

Decimal

C

1.25

11

OriginalBroadcastChannel

The broadcast channel on which the Release was originally broadcast.

OriginalBroadcastChannel is mandatory for services deemed to be “catch-up” television or streaming.

String

C

BBC One

12

OriginalBroadcastDateTime

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

OrigialBroadcastDateTime is mandatory for services deemed to be “catch-up” television or streaming.

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 or Resource provided to Consumers, including any sales adjustments. Sales adjustments include e.g. file failures.

Decimal

M

1000

16

Returns

The number of Usages of a Release or Resource returned (with refund) by Consumers 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 which 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.

PriceConsumerPaidExcSalesTax is mandatory when the CommercialModelType is PayAsYouGoModel.

Decimal

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.8 SU04.01 – AV-specific Usage Record (with FirstVodBroadcastDateTime)
This Record Type is an update to the SU04 Record Type defined above and has the same structure as SU04, albeit with two differences:
  • The RecordType shall contain the string SU04.01, instead of SU04; and
  • The following Cells will appear in addition, and to the right of, the Cells defined in SU04.
Additional Cell NameField DefinitionData TypeM/O/C?Example
23

FirstVoDBroadcastDateTime

The first broadcast of the Release as part of a Video-on-Demand service (i.e. not the very first time the Release was broadcast).

DateTime

O

2016-01-26T15:00:00Z

 5.6.9 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. Taken together with the Message ID this shall be globally and perpetually unique. 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.10 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 Usages of the UGC Release was provided to Consumers, including any sales adjustments. Sales adjustments include e.g. file failures.

Multiple Integer

M

400|655

 5.6.11 RU01.01 – UGC Release Usage Summary Record (added ContentCategory)
This Record Type is an update to the RU01 Record Type defined above and has the same structure as RU01, albeit with two differences:
  • The RecordType shall contain the string RU01.01, instead of RU01;
  • The following Cell will appear in addition, and to the right of, the Cells defined in RU01:
Additional Cell NameField DefinitionData TypeM/O/C?Example
6ContentCategoryA string categorising the content that has been used or distributed as agreed between sender and recipient.StringMMusic

 5.6.12 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 Usages of the “Head” Resource or Work was provided to Consumers, including any sales adjustments. Sales adjustments include e.g. file failures.

Integer

M

400

 5.6.13 RU02.01 – UGC Release Usage Record (added ContentCategory)
This Record Type is an update to the RU02 Record Type defined above and has the same structure as RU02, albeit with two differences:
  • The RecordType shall contain the string RU02.01, instead of RU01;
  • The following Cell will appear in addition, and to the right of, the Cells defined in RU02:
Additional Cell NameField DefinitionData TypeM/O/C?Example
8ContentCategoryA string categorising the content that has been used or distributed as agreed between sender and recipient.StringOMusic

 5.6.14 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. If a LI record applies to more than one RightsController, Message Sender and Message Recipient shall agree a mutually acceptable keywords (e.g. "all" or "conflict"). Clearly, Message Sender and Message Recipient, must take care to use keywords that do not conflict with real RightsControllers.

String

M

SACEM

5RightsControllerPartyIdThe PartyId of the RightsController. If a LI record applies to more than one rights controller, no RightsControllerPartyId shall be provided.PartyID

C

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

Decimal

M

25

8RightsTypeThe right for which the RightShare% is providedAVSOMechanicalRight
9

AllocatedNetRevenue

Net Revenue generated that is to be allocated to the MessageRecipient/RightsController in the CurrencyOfTransaction.

Decimal

M

34567

10

AllocatedAmount

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

Decimal

M

2560.77

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

 5.6.16 LI01.02 – Licensor-specific Usage Data Record (with Allocated Usages)
This Record Type is an update to the LI01.01 Record Type defined above and has the same structure as LI01.01, albeit with two differences:
  • The RecordType shall contain the string LI01.02, instead of LI01.01;
  • The following Cell will appear in addition, and to the right of, the Cells defined in LI01.01.
Additional Cell NameField DefinitionData TypeM/O/C?Example
11

AllocatedUsages

The number of Usages allocated to the RightsController.

Decimal

O

10.5

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.