- Created by DDEX Secretariat, last modified on 2021-07-01
This section of the DDEX Knowledge Base contains the Record Types used by various Profiles of the Flat File Variant of the Digital Sales Reporting Message Suite Standard
1 Introduction
The Flat File Variant of the Digital Sales Reporting Message Suite Standard has been developed in response to concerns regarding the file size and computational complexity of the XML Variant, and will lead to reduced implementation and running cost for Licensees and Licensors.
Any organisation wishing to implement this (or any other DDEX standard) is required to apply for an Implementation Licence. The terms of the licence and an application form can be found on https://ddex.net/implementation/implementation-licence-and-ddex-party-identifiers.
This version 1.4 of this Part of the DSR Standard has specifically been created to introduce Record Types necessary for the Basic Audio Profile for The Mechanical Licensing Collective.
Users of any other profile may continue to use Version 1.3 of the Record Type Definitions.
2 Scope
The message design defined in this standard provides a mechanism for Licensees (typically Digital Service Providers) to report to Licensors (typically Music Rights Societies, Audio-visual Rights Societies, 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 Records. 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.
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.
Version 1.2 adds support for the Profile for Reporting Financial Information to Record Companies documented in Part 9 and the Masterlist Profile documented in Part 10. Version 1.2 does not change any Record Types used in the Profiles documented in Parts 3-7.
Version 1.3 merges the Record Types for Multi Record Block Variants and Single Record Block Variants.
Version 1.4 (this version) adds support for the Basic Audio Profile for The Mechanical Licensing Collective as documented in Part 11. Version 1.4 does not change any Record Types used in the Profiles documented in Parts 3-7 and 9-10. In addition, a number of Cell names were harmonised across Record Types (without any change in their meaning).
Below is the list of changes made to the Various Record Types over time. Where a Cell in a specific Record Type is changed, or where a Cell is being added to a specific Record Type, in this Version of Part 8 of the Digital Sales Reporting Message Suite Standard, this is marked with "(new)" or "(updated)". Lines marked in red indicate changes made in Version 1.4:
Record Type and Version | Cell | Change | Comment | |||
Summary Record Types | ||||||
---|---|---|---|---|---|---|
SY01 | 01 | CurrencyOfTransaction | Added |
| ||
ExchangeRate | Added |
| ||||
02 | UseType | Changed cardinality to conditional |
| |||
SY02 | 01 | RightsType | Added |
| ||
02 | ContentCategory | Added |
| |||
CurrencyOfTransaction | Added |
| ||||
ExchangeRate | Added |
| ||||
RightsTypePercentage | Added |
| ||||
03 | UseType | Changed cardinality to conditional |
| |||
SY03 | 01 | UseType | Changed cardinality to conditional |
| ||
SubscriberType | Added | |||||
SY04 | 01 | MusicUsagePercentage | Added |
| ||
02 | UseType | Changed cardinality to conditional |
| |||
SY05 | 01 | Currency | Added |
| ||
ExhangeRateBaseCurrenty | Added |
| ||||
ExchangeRate | Added |
| ||||
SubscriberType | Added |
| ||||
SubPeriodStartDate | Added |
| ||||
SubPeriodEndDate | Added |
| ||||
02 | ContentCategory | Added |
| |||
RightsTypePercentage | Added |
| ||||
03 | UseType | Changed cardinality to conditional |
| |||
ParentSummaryRecordId | Added |
| ||||
MusicUsagePercentage | Cell name changed | |||||
SY06 | 01 | CurrencyOfTransaction | Added |
| ||
ExchangeRate | Added |
| ||||
02 | UseType | Changed cardinality to conditional |
| |||
ViewerHours | Added |
| ||||
SY07 | 01 | CurrencyOfTransaction | Added |
| ||
ExchangeRate | Added |
| ||||
RightsTypePercentage | Added |
| ||||
SY08 | 01 | CurrencyOfTransaction | Added |
| ||
ExchangeRate | Added |
| ||||
RightsTypePercentage | Added |
| ||||
02 | UseType | Changed cardinality to conditional |
| |||
IndirectValue | Cell renamed from IndirectNetRevenue |
| ||||
SY09 | 01 | UseType | Changed cardinality to conditional |
| ||
SubPeriodStartDate | Added |
| ||||
SubPeriodEndDate | Added |
| ||||
ParentSummaryRecordId | Added |
| ||||
SY10 | 01 | UseType | Changed cardinality to conditional |
| ||
MusicUsagePercentage | Cell name changed | |||||
SY11 | 01 | UseType | Changed cardinality to conditional |
| ||
SY12 | ||||||
Record Types to describe Releases | ||||||
RE01
| 01 | DisplayArtistName | Cardinality changed to conditional | |||
02
| DataProvider | Updated Definition | ||||
ReleaseDate | Added | |||||
RE02 | ||||||
RE03
| 01 | VideoCategory | Added | |||
EpisodeNumber | Added | |||||
UserChannelName | Added | |||||
02 | DataProvider | Updated Definition | ||||
RE04 | New Record Type | |||||
Record Types to describe Resources | ||||||
AS01 | 01 | ISRC | Datatype changed to multiple string | |||
DisplayArtistName | Cardinality changed to conditional | |||||
02 | ISRC | Datatype changed to string | Newly introduced LC01 record is a better mechanism to communicate multiple IRSCs from multiple sources | |||
IsSubjectToOwnershipConflict | Added | |||||
LastConflictCheck | Added | |||||
AS02
| 01 | PropriataryWorkId | Added | |||
02 | IsMasterRecording | Added | ||||
03 | DisplayArtistName | Cardinality changed to conditional | ||||
ProprietaryWorkId | Datatype changed to multiple string | |||||
DataProvider | Added | |||||
IsSubjectToOwnershipConflict | Added | |||||
LastConflictCheck | Added | |||||
AS03
| 01
| EpisodeNumber | Cardinality changed to multiple integer | |||
FirstVoDBroadcastDate | Added | |||||
02
| ProuctionCompanyName | Added | ||||
ProductionCompanyPartyId | Added | |||||
CueSheetDataProvider | Added | |||||
AS04 |
| |||||
AS05 | New Record Type | |||||
AS06 | New Record Type | |||||
LC01 | ||||||
Record Types to describe Works and Cues | ||||||
MW01
| 01 | ProprietaryWorkId | Added | |||
02 | ResourceReference | Added | ||||
ParentLicensorDataRecordId | Added | |||||
ParentMasterlistId | Added | |||||
MW02 | New Record Type | |||||
RC01 | New Record Type | |||||
CU01 | 01 | CueSheetDataProviderName | Added | |||
CU02 | New Record Type | |||||
Record Types to describe Sales and/or Usage Data | ||||||
SU01 | 01 |
|
| |||
02 | UseType | Added | ||||
SU02 | 01 | NumberOfStreams | Datatype changed to decimal | |||
02 | UseType | Added | ||||
SU03 | 01 | SummaryRecordId | Cardinality changes to conditional | |||
02 | DspResourceId | Cell renamed from DspReleaseId | Bug fix | |||
Usages | Datatype changed to decimal | |||||
ContentCategory | Added | |||||
IsRoyaltyBearing | Added | |||||
SU04 | 01 | FirstVoDBroadcastDateTime | Added | |||
02 | IsDrmEnforced | Datatype changed to Boolean | ||||
UseType | Added | |||||
SU05 | 01 | UseType | Added | |||
RU01 | 01 | ContentCategory | Added | |||
02 | ParentResourceReference | Added | ||||
RU02 | 01 | ContentCategory | Added | |||
02 | ParentResourceReference | Added | ||||
LI01
| 01 | SummaryRecordId | Cardinality changes to conditional | |||
02 | AllocatedUsages | Added | ||||
03
| AllocatedNetRevenue | Cardinality changes to conditional | ||||
AllocatedAmount | Cardinality changes to conditional | |||||
ParentSalesTransactionId | Added | |||||
LicensorDataRecordId | Added | |||||
ST01 | ||||||
Miscellaneous Record Types | ||||||
ML01 | 01 | MasterlistId | Added | |||
DExx | ||||||
Single Record Block Record Types | ||||||
SR01
| 01 | ProprietaryWorkId | Datatype changed to Multiple String::String | |||
ReleaseDate | Added | |||||
UseType | Added | |||||
SR02 | 01 | ReleaseDate | Added | |||
UseType | Added | |||||
PriceConsumerPaidExcSalesTax | Added | |||||
SR03 | 01 | AllocatedNetUsage | Deprecated | |||
SR04 | 01 | CueSheetDataProvider | Added | |||
UseType | Added | |||||
SR05 | 01 | UseType | Added | |||
PriceConsumerPaidExcSalesTax | Added | |||||
CueSheetDataProvider | Added | |||||
SR06 | 01 | AllocatedNetRevenue | Added | |||
SR07 | 01 | NumberOfTransactedResources | Added | |||
ReleaseDate | Added | |||||
SR08 | 01 | RightSharePercentage | Condition augmented |
3 Normative References
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.
- DDEX. Digital Sales Reporting Message Suite Standard - Part 2: Allowed Value Sets.
4 Terms and Abbreviations
The terms and abbreviations used in Digital Sales Reporting Message Suite Standard - Part 1: Architecture of the Flat File Variant (Version 1.2) also apply to this Standard.
5 Record Type Definitions
5.1 Header and Footer Record Types
Cell Name | Field Definition | Data Type | M/O/C? | 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
The specific values for the architecture is provided in each of the Parts defining a Profile for this standard. 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 |
3 | Profile | The Identifier of the Profile used for the Message. | String | M | BasicAudioProfile |
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 than 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 |
Cell Name | Field Definition | Data Type | M/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. | Integer | M | 109 |
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 |
4 | NumberOfSummaryRecords | Number of Records in accordance with the relevant profile. | Integer | M | 20 |
5 | NumberOfBlocksInFile | Number of Blocks of Records in the file in accordance with the relevant profile. | Integer | M | 10 |
6 | NumberOfBlocksInReport | 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. | Integer | C | 65 |
Cell Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “SRFO”. | Fixed string | M | SRFO |
2 | 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 of Part 1 of the Digital Sales Report Message Suite Standard) and commented-out Records (in accordance with Clause 6.6.9 of Part 1 of the Digital Sales Report Message Suite Standard). | Integer | M | 1234 |
3 | NumberOfSummaryRecords | Number of Summary Records communicated in the Sales Report Message. | Integer | M | 20 |
5.2 Summary Record Types
Cell Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “SY01.02”. | Fixed string | M | SY01.02 |
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 | PayAsYouGoModel |
6 (update) | 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 must be provided when there is no UseType on the relevant detailed Record(s). | AVS | C | 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. ServiceDescription shall be provided if a Message Sender offers multiple services that need to be differentiated in this sales/usage report. | String | C | PremiumService |
9 | TotalUsages | 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. | 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 | 12345 |
11 | CurrencyOfReporting | The Currency in which the NetRevenue and IndirectValue are provided (represented by an ISO 4217 CurrencyCode). | AVS | M | CAD |
12 | NetRevenue | The revenue generated by the DSP for the potential distribution of Releases or Resources, regardless of the Commercial Model or Use Type used, based on the bilateral agreement between Licensee and Licensor. | Decimal | M | 223345.12 |
13 | IndirectValue | The revenue generated by the DSP that cannot directly be allocated to individual Releases or Resources, regardless of the Commercial Model or Use Type used, based on the bilateral agreement between Licensee and Licensor. IndirectValue shall only be provided when indirect revenues were generated. This may include a value ascribed to a service for which no direct remuneration occurs. | Decimal | C | 13424.50 |
14 | CurrencyOfTransaction | The currency in which the Licensee generated the revenue (represented by an ISO 4217 CurrencyCode). | AVS | O | USD |
15 | ExchangeRate | The Exchange rate used to convert from the currency used for the transactions into the currency of reporting. | Decimal | O | 1.205648 |
Cell Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “SY02.03” | Fixed String | M | SY02.03 |
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 | AdvertisementSupportedMode |
6 (updated) | 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 must be provided when there is no UseType on the relevant detailed Record(s). | AVS | C | 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 | TotalUsages | 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 | Users | The number of Users with whom the Release or Resource were transacted. | Integer | O | 1234 |
11 | CurrencyOfReporting | The Currency in which the NetRevenue, AllocatedRevenue and AllocatedNetRevenue are provided (represented by an ISO 4217 CurrencyCode. | AVS | M | CAD |
12 | NetRevenue | The revenue generated by the DSP for the distribution of Releases or Resources, regardless of the Commercial Model or Use Type used, based on the bilateral agreement between Licensee and Licensor. | 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 |
14 | RightsControllerPartyId | PartyId of the RightsController that is believed by the MessageSender to control a RightShare of the Work | PartyId | O | ISNI::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 |
18 | RightsType | A Type of Right which is covered. | AVS | O | MechanicalRight |
19 | ContentCategory | A string categorising the content that has been used or distributed as agreed between sender and recipient. | String | M | Music |
20 | CurrencyOfTransaction | The currency in which the Licensee generated the revenue. (represented by an ISO 4217 CurrencyCode). | AVS | O | USD |
21 | ExchangeRate | The Exchange rate used to convert from the currency used for the transactions into the currency of reporting. | Decimal | O | 1.205648 |
22 | RightsTypePercentage | 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. | Decimal | C | 10.00 |
Cell Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “SY03.01” | Fixed string | M | SY03.01 |
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 needs to be provided if the Message Sender offers multiple distribution channels that need to be differentiated in this Sales/Usage Report. | 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 (updated) | 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 must be provided when there is no UseType on the relevant detailed Record(s). | AVS | C | 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 | TotalUsages | 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 | CurrencyOfReporting | The Currency in which the NetRevenue, ConsumerPaidUnitPrice, AllocatedRevenue and AllocatedNetRevenue are provided (represented by an ISO 4217 CurrencyCode). | AVS | M | CAD |
12 | NetRevenue | The revenue generated by the DSP for the distribution of Releases or Resources, regardless of the Commercial Model or Use Type used, based on the bilateral agreement between Licensee and Licensor. | 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 |
14 | RightsControllerPartyId | PartyId of the RightsController that is believed by the MessageSender to control a RightShare of the Work | PartyId | O | ISNI::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 |
20 | FreeOrTrialSubscribers | The number of non-paying Subscribers (including Subscribers in a non-paying trial period). | Decimal | M | 1239867 |
21 | CurrencyOfTransaction | The currency in which the revenue has to be reported (represented by an ISO 4217 CurrencyCode). | AVS | O | USD |
22 | ExchangeRate | The Exchange rate used to convert from the currency used for the transactions into the currency of reporting. | Decimal | O | 1.205648 |
23 (new) | SubscriberType | The type of Subscriber | String | O | Student |
Cell Name | Field Definition | Data Type | M/O/C | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “SY04.02” | Fixed string | M | SY04.02 |
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 (updated) | 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 must be provided when there is no UseType on the relevant detailed Record(s). | AVS | C | 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 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 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 | TotalUsagesInSubPeriod | 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 | TotalUsagesInReportingPeriod | 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 | CurrencyOfReporting | Currency used to report Net Revenue, AllocatedNetRevenue and AllocatedRevenue (represented by an ISO 4217 CurrencyCode). | AVS | M | CAD |
16 | CurrencyOfTransaction | Currency in which the Licensee generated the revenue 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. To be provided based on bilateral agreements. | Decimal | C | 6.62 |
19 | NetRevenue | The revenue generated by the DSP for the distribution of Releases or Resources, regardless of the Commercial Model or Use Type used, based on the bilateral. agreement between Licensee and Licensor. Net Revenue of the DSP generated from the distribution of Releases or Resources, as well as sales of products based on Releases or Resources. To be provided based on bilateral agreements. | Decimal | C | 10545.12 |
20 | MusicUsagePercentage | The percentage of musical content in the subscription service. To be provided based on bilateral agreements. | Decimal between 0 and 100 | C | 14.54 |
DistributionChannel, DistributionChannelId, TotalUsages and MusicUsagePercentage 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.03” | Fixed string | M | SY05.03 |
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 (updated) | UseType | The nature of a Service, or a Release, as used by a Consumer. UseType must be provided when there is no UseType on the relevant detailed Record(s). | AVS | C | Stream |
7 | Territory | The Territory for which the sale/transaction is reported. | AVS | M | FR |
8 | ServiceDescription | The service name (e.g. a service tier) under which the SalesTransaction took place. The ServiceDescription may not contain space characters or underscores. | String | C | PremiumService |
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 |
12 | TotalUsages | The number of Usages generated by the Service. | Integer | C | 2324 |
13 | AllocatedUsages | The number of Usages allocated to the RightsController. | Multiple Decimal | O | 411.29 |
14 | MusicUsagePercentage | The percentage of musical content in the subscription service. | Decimal | C | 34.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 |
18 | CurrencyOfReporting | Currency used to report AllocatedNetRevenueNetRevenue, and AllocatedRevenue (represented by an ISO 4217 CurrencyCode). | AVS | O | EUR |
19 | CurrencyOfTransaction | The currency in which the Licensee generated the revenue Currency used for ConsumerPaidUnitPrice (represented by an ISO 4217 CurrencyCode). | AVS | O | CHF |
20 | ExchangeRate | The Exchange rate used to convert from the currency used for the transactions into the currency of reporting. | Decimal | O | 1.23 |
21 | Deprecated Cell | This Cell is not to be used. | |||
22 | SubPeriodStartDate | Start of the SubPeriod, the meaning of which is agreed between Sender and Recipient. | Date | O | 2015-01-01 |
23 | SubPeriodEndDate | End of the SubPeriod, the meaning of which is agreed between Sender and Recipient. | Date | O | 2015-10-01 |
24 | ContentCategory | A string categorising the content that has been used or distributed as agreed between sender and recipient. | String | M | Music |
25 | RightsTypePercentage | 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 permissible 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. | Decimal | C | 10.00 |
26 (new) | ParentSummaryRecordId | The Identifier (specific to the Message) of the Summary Record that this Summary Record provides details for. ParentSummaryRecordId shall only be provided if Summary records are used to provide summary information in a hierarchical manner. | String | C | 1234 |
Cell Name | Field Definition | Data Type | M/O/C | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “SY06.02” | Fixed string | M | SY06.02 |
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 | 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 (updated) | 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 must be provided when there is no UseType on the relevant detailed Record(s). | AVS | C | 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 | TotalUsages | 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 | CurrencyOfReporting | The Currency in which the NetRevenue and IndirectValue 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 | The revenue generated by the DSP for the distribution of Releases or Resources, regardless of the Commercial Model or Use Type used, based on the bilateral agreement between Licensee and Licensor. | Decimal | O | 223345.12 |
14 | IndirectValue | The revenue generated by the DSP that cannot directly be allocated to individual Releases or Resources, regardless of the Commercial Model or Use Type used, based on the bilateral agreement between Licensee and Licensor. IndirectValue 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 |
16 | CurrencyOfTransaction | Currency used for consumer-based financial information (represented by an ISO 4217 CurrencyCode). | AVS | O | EUR |
17 | ExchangeRate | The Exchange rate used to convert from the currency used for the transactions into the currency of reporting. | Decimal | O | 1234 |
18 (new) | ViewerHours | The total duration that the Release or Resource has been accessed by consumers. | ISO Duration | M | PT135H |
Cell Name | Field Definition | Data Type | M/O/C | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “SY07.01” | Fixed String | M | SY07.01 |
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 | TotalUsages | 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 | CurrencyOfReporting | The Currency in which the NetRevenue, AllocatedRevenue and AllocatedNetRevenue are provided (represented by an ISO 4217 CurrencyCode. | AVS | M | EUR |
13 | NetRevenue | The revenue generated by the DSP for the distribution of Releases or Resources, regardless of the Commercial Model or Use Type used, based on the bilateral agreement between Licensee and Licensor. | 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 |
19 | CurrencyOfTransaction | Currency used for consumer-based financial information (represented by an ISO 4217 CurrencyCode). | AVS | O | EUR |
20 | ExchangeRate | The Exchange rate used to convert from the currency used for the transactions into the currency of reporting. | Decimal | O | 1234 |
21 | RightsTypePercentage | 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 permissible to communicate a RightsType without a RightsTypePercentage. Cells 10 (TotalUsages), 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. | Decimal | C | 10.00 |
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.02” | Fixed String | M | SY08.02 |
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 | BroadcastOrChannel
| 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 (updated) | 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 must be provided when there is no UseType on the relevant detailed Record(s). | AVS | C | 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 Resources were listened to as part of the broadcast. Note: in SU05 the equivalent Cell is called ListenerDuration with a data type of Duration. | Decimal | M | 123.4 |
13 | CurrencyOfReporting | The Currency in which the NetRevenue, AllocatedRevenue and AllocatedNetRevenue are provided (represented by an ISO 4217 CurrencyCode. | AVS | M | EUR |
14 | NetRevenue | The revenue generated by the DSP for the distribution of Releases or Resources, regardless of the Commercial Model or Use Type used, based on the bilateral agreement between Licensee and Licensor. | Decimal | M | 565.86 |
15 (updated) | IndirectValue | The amount generated or assigned by the DSP that cannot directly be allocated to individual Releases or Resources, regardless of the Commercial Model or Use Type used, based on the bilateral agreement between Licensee and Licensor. IndirectValue shall only be provided when indirect revenues were generated. Examples include: sponsorship agreements. | 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 broadcasting 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 | RightsControllerAllocated | 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 |
|
23 | CurrencyOfTransaction | Currency used for consumer-based financial information (represented by an ISO 4217 CurrencyCode). | AVS | O | EUR |
24 | ExchangeRate | The Exchange rate used to convert from the currency used for the transactions into the currency of reporting. | Decimal | O | 1234 |
25 | RightsTypePercentage | 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 permissible 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. | Decimal | C | 33.33 |
Cell Name | Field Definition | Data Type | M/O/C | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “SY09.01” | Fixed String | M | SY09.01 |
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 |
4 (updated) | UseType | The nature of a Service, or a Release, as used by a Consumer. UseType must be provided when there is no UseType on the relevant detailed Record(s). | AVS | C | Stream |
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. | String | C | PremiumService |
7 | Deprecated Cell (SubscriberType) | This Cell is not to be used. | |||
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 as a result of the way in which the Consumer accessed the Resource. A RightsType shall be provided when it applies to the accessed 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. | Decimal | C | 1066.45 |
12 | AllocatedUsages | The number of Usages allocated to the RightsController. | Decimal | O | 135.23 |
13 | NetRevenue | The revenue generated by the DSP for the distribution of Releases or Resources, regardless of the Commercial Model or Use Type used, based on the bilateral agreement between Licensee and Licensor. | Decimal | M | 1220.06 |
14 | IndirectValue | The revenue generated by the DSP that cannot directly be allocated to individual Releases or Resources, regardless of the Commercial Model or Use Type used, based on the bilateral agreement between Licensee and Licensor. IndirectValue shall only be provided when indirect revenues were generated. | Decimal | C | 120.81 |
15 | RightsControllerMarketShare | The ratio in percent between TotalUsages and AllocatedUsages | Decimal | O | 10.54 |
16 | CurrencyOfReporting | The Currency in which the NetRevenue and IndirectValue are provided (represented by an ISO 4217 CurrencyCode). | AVS | M | CZK |
17 | CurrencyOfTransaction | The currency in which the Licensee generated the revenue. Currency used for consumer-based financial information (represented by an ISO 4217 CurrencyCode). | AVS | O | EUR |
18 | ExchangeRate | The Exchange rate used to convert from the currency used for the transactions into the currency of reporting. | Decimal | O | 1234 |
19 | RightsTypePercentage | 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. | Decimal | C | 10.00 |
20 (new) | SubPeriodStartDate | The StartDate of the reporting Period covered by the Summary Record (in ISO 8601 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]]. SubPeriodStartDate shall only be provided when they differ from the UsageStartDate and UsageEndDate in the message header Record. SubPeriodStartDate and SubPeriodEndDate shall always be provided together. The SubPeriodStartDate must not be earlier than the UsageEndDate provided in the relevant header record. | Date | C | 2014-12-01 |
21 (new) | SubPeriodEndDate | The EndDate of the reporting Period covered by the Summary Record (in ISO 8601 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]]. SubPeriodEndDate shall only be provided when they differ from the UsageStartDate and UsageEndDate in the message header Record. SubPeriodStartDate and SubPeriodEndDate shall always be provided together. The SubPeriodEndDate must not be later than than the UsageEndDate provided in the relevant header record and must not be earlier than the SubPeriodStartDate | Date | C | 2014-12-01 |
22 (new) | ParentSummaryRecordId | The Identifier (specific to the Message) of the Summary Record that this Summary Record provides details for. ParentSummaryRecordId shall only be provided if Summary records are used to provide summary information in a hierarchical manner. | String | C | 1234 |
Cell Name | Field Definition | Data Type | M/O/C | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record, always to contain “SY10.01”
| Fixed String | M | SY10.01 |
2 | SummaryRecordId | The Identifier (specific to the Message) of the Summary Record. This Identifier shall be referenced in 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. DistributionChannelName 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 needs to be provided if the Message Sender offers multiple distribution channels that need to be differentiated in this Sales/Usage Report. Note: this terms differs from DistributionChannel as used in the Electronic Release Notification where a Distribution Channel is the specific DSP through which a Release may be made available. This may, or may not, map to a DistributionChannel as used in a sales/usage report. | 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 (updated) | 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 must be provided when there is no UseType on the relevant detailed Record(s). | AVS | C | PermanentDownload |
6a | ReportingPeriodStartDate | The StartDate of the reporting Period covered by the Summary Record (in ISO 8601 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]]. The ReportingPeriodStartDate must not be earlier than than the UsageEndDate provided in the header record. | Date | M | 2017-06-01 |
6b | ReportingPeriodEndDate | The EndDate of the reporting Period covered by the Summary Record (in ISO 8601 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]]. The ReportingPeriodEndDate must not be later than than the UsageEndDate provided in the header record and must not be earlier than the ReportingPeriodStartDate. | Date | M | 2017-06-01 |
7 | SubscriberType | The type of Subscriber. Sender and Recipient will need to agree values for this field. SubscriberType needs to be provided if the sales report covers subscriptions. | String | C | Student |
8 | Subscribers
| The number of subscribers to a Service for each SubscriberType. Sender and Recipient will need to agree values for this field. Subscribers needs to be provided if the sales report covers subscriptions. | Decimal | C | 12245.4 |
9 | ActiveSubscribers | The number of active subscribers to a Service for each SubscriberType. What constitutes an ActiveSubscriber will depend on the agreement between Sender or Receiver. ActiveSubscribers needs to be provided if the sales report covers subscriptions. | Decimal | C | 12245.4 |
10 | PromotionalActivity | A Description of a promotional activity. Sender and Recipient will need to agree values for this field. PromotionalActivity needs to be provided if a specific promotional activity was active at the time of the sale/use and which may have impacted on the sale/use. | String | C | HalloweenSpecial |
11 | Territory | The Territory for which the Sale/Usage is reported. | AVS | M | US |
12 | 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 needs to be provided if the Message Sender offers multiple services that need to be differentiated in this sales/usage report. | String | C | YTRed |
13 | OfferType | Information on the type of offer involved in the consumer transaction. Sender and Recipient will need to agree values for this field. | String | O | CompleteMyAlbum |
14 | Quality | Information on the quality of the Resources/Releases involved in the consumer transaction. | String | O | UpgradeToHiResMusic |
15 | 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. | Decimal | M | 12337.91826 |
16 | AllocatedUsages | 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. | Decimal | M | 12334.78766 |
17 | 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. If no returns are to be reported the value should be 0. | Integer
| M | 12 |
18 | MusicUsagePercentage | Percentage of music usage on a service. | Decimal | M | 66.66 |
19 | CurrencyOfTransaction | The Currency in which the SalesTransactions have occurred (represented by an ISO 4217 CurrencyCode). This may be the same as the CurrencyOfAccounting. | AVS | M | USD |
20 | CurrencyOfAccounting | The Currency in which the SalesTransactions are accounted (represented by an ISO 4217 CurrencyCode). | AVS | M | EUR |
21 | ExchangeRate | The rate used to convert from the CurrencyOfTransaction to the CurrencyOfAccounting | Decimal | M | 1. 009 |
22 | ExchangeRateSource | The source of the ExchangeRate. | String | C | |
23 | DateOfCurrencyExchange | The date and time on which the ExchangeRate was determined. The only allowed format is ISO 8601 YYYY-MM-DDThh:mm:ssTZD). The DateOfCurrencyExchange shall be provided if an ExchangeRate is provided. | ISO datetime | C | 2014-12-14T10:05:00Z |
24 | GrossRevenueInCurrencyOfTransaction
| Gross Revenue of the DSP generated from the distribution of Releases or Resources in the CurrencyOfTransaction. This Cell needs to be provided if applicable to the deal. When provided, the next cell needs to be provided as well. | Decimal | C | 1176153.10 |
25 | GrossRevenueInCurrencyOfAccounting | Gross Revenue of the DSP generated from the distribution of Releases or Resources in the CurrencyOfAccounting. This Cell needs to be provided if applicable to the deal. When provided, the previous cell needs to be provided as well. | Decimal | C | 1176153.10 |
26 | CalculationType | The type of the calculation made to the amounts reported in this Record. Types might include minimum amount or rate payable. Sender and Recipient will need to agree values for this field. | Multiple String | O | MinimumAmount|MaximumAmount |
27 | CalculationValue | The value of the minimum amount or rate payable indicated by the corresponding value in CalculationType. One CalculationValues needs to be provided for each CalculationType. | Multiple Decimals | O | 52.24|72.66
|
28 | DeductionType | Different types of deductions that the DSP applies before allocating revenue to the DSP/MessageSender. DeductionType needs to be provided if applicable to the deal. When provided, the next two need to be provided as well. | Multiple String | C
|
|
29 | Deductions | Deductions that the DSP applies before allocating revenue to the MessageRecipient/RightsController in the CurrencyOfTransaction. One Deduction amount has to be provided for each DeductionType. | Multiple Decimals | C | 1452.24|12372.66 |
30 | Deductions | Deductions that the DSP applies before allocating revenue to the MessageRecipient/RightsController in the CurrencyOfAccounting. One Deduction amount has to be provided for each DeductionType. | Multiple Decimals | C
| 1452.24|12372.66 |
31 | 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 | 1176153.65 |
32 | NetRevenue | Net Revenue of the DSP generated from the distribution of Relea ses or Resources , as well as sales of products based on Releases or Resources in the CurrencyOfAccounting. | Decimal | M | 1176153.65 |
33 | AllocatedRevenue | The amount allocated to the MessageRecipient/RightsController for the Usages reported in the CurrencyOfTransaction. | Decimal | M | 76153.65 |
34 | AllocatedRevenue | The amount allocated to the MessageRecipient/RightsController for the Usages reported in the CurrencyOfAccounting. | Decimal | M | 76153.65 |
35 | AllocatedNetRevenue | Net Revenue generated that is to be allocated to the MessageRecipient/RightsController in the CurrencyOfTransaction.
| Decimal | M | 153.65 |
36 | AllocatedNetRevenue | Net Revenue generated that is to be allocated to the MessageRecipient/RightsController in the CurrencyOfAccounting. | Decimal | M | 153.65 |
37 | RightsControllerMarketShare | Market share as defined by the contract between sender and recipient. RightsControllerMarketShare needs to be provided if required in the agreement between Message Sender and Message Recipient.
| Decimal | C | 22.32 |
38 | SubscriptionFee | Price for one subscription generated by the DSP in the CurrencyOfTransaction. SubscriptionFeeInCurrencyOfTransaction needs to be provided if required in the agreement between Message Sender and Message Recipient. | Decimal | C | 10.0 |
39 | SubscriptionFee | Price for one subscription generated by the DSP in the CurrencyOfAccounting. | Decimal | M | 7.35 |
40 | UsageIndependentFeeType | The type of a fee payable payable to the RightsController independent from any usage generated based on RightsController's content. UsageIndependentFeeType must be provided when fees are applicable; Sender and Recipient will need to agree values for this field. | Multiple String | C | GuaranteedMinimum| GuaranteedMaximum |
41 | UsageIndependentFee
| Fee payable to the RightsController independent from any usage generated based on RightsController's content in the CurrencyOfTransaction. One UsageIndependentFeeInCurrencyOfTransaction needs to be provided for each UsageIndependentFeeType. | Multiple Decimal | C | 10089.92 |
42 | UsageIndependentFee | Fee payable to the RightsController independent from any usage generated based on RightsController's content in the CurrencyOfAccounting. One UsageIndependentFeeInCurrencyOfAccounting needs to be provided for each UsageIndependentFeeType. | Multiple Decimal | C | 10089.92 |
43 | FinalTotalAmount | The total amount of all allocated amounts in the CurrencyOfTransaction, including the UsageIndependentFeeInCurrencyOfTransaction, reported in this Record. | Decimal | M | 555.654 |
44 | FinalTotalAmount | The total amount of all allocated amounts in the CurrencyOfAccounting, including the UsageIndependentFeeInCurrencyOfAccounting, reported in this Record. | Decimal | M | 555.654 |
Cell Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “SY11.01”. | Fixed string | M | SY11.01 |
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 | 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 | PayAsYouGoModel |
6 (updated) | 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 must be provided when there is no UseType on the relevant detailed Record(s). | AVS | C | PermanentDownload |
7 | Territory | The Territory for which the prospective 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. ServiceDescription shall be provided when essential to the commercial relationship being reported on. | String | C | PremiumService |
9 | UsageForPrioritisaiton | The sum of the number of the UsageForPrioritisaiton in reference ML01 Records. UsageForPrioritisaiton has to be provided if such information is available, based on bilateral agreements. This information is intended to aid the Message Recipient to prioritise handling the information provided in the report. | Integer | C | 400 |
This is the Record to communicate basic summary information about Usages, Sales and Revenues to the Mechanical Licensing Collective established by the US’ Music Modernization Act.
Cell Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “SY12”. | Fixed string | M | SY12 |
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 | 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 must be provided when there is no UseType on the relevant detailed Record(s). | AVS | C | 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. ServiceDescription shall be provided if a Message Sender offers multiple services that need to be differentiated in this sales/usage report. | String | C | PremiumService |
9 | TotalUsages | 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. | 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 | 12345 |
11 | CurrencyOfReporting | The Currency in which the NetRevenue and IndirectValue are provided (represented by an ISO 4217 CurrencyCode). | AVS | M | CAD |
12 | NetRevenue | The revenue generated by the DSP for the potential distribution of Releases or Resources, regardless of the Commercial Model or Use Type used, based on the bilateral agreement between Licensee and Licensor. | Decimal | M | 223345.12 |
13 | IndirectValue | The revenue generated by the DSP that cannot directly be allocated to individual Releases or Resources, regardless of the Commercial Model or Use Type used, based on the bilateral agreement between Licensee and Licensor. IndirectValue shall only be provided when indirect revenues were generated. This may include a value ascribed to a service for which no direct remuneration occurs. | Decimal | C | 13424.50 |
14 | CurrencyOfTransaction | The currency in which the Licensee generated the revenue (represented by an ISO 4217 CurrencyCode). | AVS | O | USD |
15 | ExchangeRate | The Exchange rate used to convert from the currency used for the transactions into the currency of reporting. | Decimal | O | 1.205648 |
16 | TotalCostOfContentIn CurrencyOfReporting | The total amount expensed by the Licensee for the right to distribute the Release or Resource on its service in the currency of reporting. | Decimal | M | 108.15 |
17 | PerformanceRoyaltiesIn CurrencyOfReporting | The total license fees payable by the Licensee for the right to perform the Musical Works used on its service in the currency of reporting. | Decimal | M | 314.75 |
5.3 Release Record Types
Cell Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “RE01.02” | Fixed string | M | RE01.02 |
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 | ReleaseCatalogNumber | The catalogue number of the Release assigned by the issuing record company | String | O | 123456 |
7 | ReleaseICPN | 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. ReleaseICPN 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 | ReleaseDisplayArtistName | The Name to be used by a DSP when presenting Artist details of the Release to a Consumer. ReleaseDisplayArtistName shall be provided if available. | String | C | The Beatles |
9 | ReleaseDisplayArtistPartyId | The PartyId of the DisplayArtist | PartyID | O | ISNI::0000000081266409 |
10 | ReleaseTitle | The ReferenceTitle of the Release | String | M | Beatles for Sale |
11 | ReleaseSubTitle | A Descriptor which is supplementary to, but not contained within, a ReleaseTitle | String | O | Live Version |
12 | ReleaseType | The form in which a ReleaseCreator anticipates offering the Release to Consumers. | AVS | O | Album |
13 | ReleaseLabelName | The Name of the Label for the Release. | String | O | Apple Records |
14 | ReleasePLine | The PLine for the Release | String | O | ℗1970 Apple Records |
15 (updated) | DataProviderName | The Name of the company that provided the Release information to the MessageSender. If the Licensee generated the data provided in this record, the DataProviderName shall contain the Name of the Licensee. | String | O | UMG |
16 (new) | ReleaseDate | The date when the Release was first made available, whether for physical or electronic/online distribution. | ISO Date | O | 1969-08-26 |
Cell Name | Field Definition | Data Type | M/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 |
Cell Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “RE03.02” | Fixed string | M | RE03.02 |
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 | ProprietaryReleaseId | The ProprietaryIdentifier of the Release preceded by a namespace identifier in the syntax ns::id | Multiple String::String | O | Myns::4534|ns2::4896 |
6 | ReleaseICPN | 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. ReleaseICPN 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 | ReleaseTitle | The ReferenceTitle of the Release | String | M | The Hamburger Postulate |
8 | ReleaseSubTitle | A Descriptor which is supplementary to, but not contained within, a ReleaseTitle. | 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 | ReleaseDisplayArtistName | The Name to be used by a DSP when presenting Artist details of the Release to a Consumer | String | O | David Brent |
12 | ReleaseDisplayArtistPartyId | 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 (updated) | DataProviderName | The Name of the company that provided the Release information to the MessageSender If the Licensee generated the data provided in this record, the DataProviderName shall contain the Name of the Licensee. | String | O | UMG |
15 | VideoCategory | A description of the content of the video as agreed between sender and recipient to classify the used Release. | String | O | Sport |
16 | EpisodeNumber | 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 |
Cell Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “RE04” | Fixed string | M | RE04 |
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 | ReleaseCatalogNumber | The catalogue number of the Release assigned by the issuing record company | String | O | 123456 |
7 | ReleaseICPN | 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. ReleaseICPN 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 | ReleaseDisplayArtistName | The Name used by the DSP when presenting Artist details of the Release to a Consumer. ReleaseDisplayArtistName shall be provided if available. Information on DisplayArtistNames and DisplayArtists can be found on the DDEX Knowledge Base (kb.ddex.net). | String | C | The Beatles |
9 | ReleaseDisplayArtistPartyId | The PartyId of the DisplayArtist | PartyID | O | ISNI::0000000081266409 |
10 | ReleaseTitle | The Title of the Release as displayed to the consumer. | String | M | Beatles for Sale |
11 | ReleaseSubTitle | A Descriptor which is supplementary to, but not contained within, a ReleaseTitle | String | O | Live Version |
12 | ReleaseType | The form in which a ReleaseCreator anticipates offering the Release to Consumers. | AVS | O | Album |
13 | ReleaseLabelName | The Name of the Label for the Release. | String | O | Apple Records |
14 | ReleasePLine | The PLine for the Release | String | O | ℗1970 Apple Records |
15 | DataProviderName | The Name of the company that provided the Release information to the MessageSender. If the Licensee generated the data provided in this record, the DataProviderName shall contain the Name of the Licensee. | String | O | UMG |
16 | ReleaseDate | The date when the Release was first made available, whether for physical or electronic/online distribution. | ISO Date | O | 1969-08-26 |
17 | ReleaseDisplayArtistNameAsReceived | The ReleaseDisplayArtistName as received by the DSP. The ReleaseDisplayArtistNameAsReceived shall only be provided if it differs from the ReleaseDisplayArtistName reported in Cell 8. Information on DisplayArtistNames and DisplayArtists can be found on the DDEX Knowledge Base (kb.ddex.net). | Multiple String | C | Coldplay vs Swedish House Mafia |
18 | ReleaseDisplayArtistAsReceived | The DisplayArtist information as received by the DSP. Information on DisplayArtistNames and DisplayArtists can be found on the DDEX Knowledge Base (kb.ddex.net). | Multiple String | O | Coldplay|Swedish House Mafia |
19 | ReleaseTitleAsReceived | The ReleaseTitle as received by the DSP. The ReleaseTitleAsReceived shall only be provided if it differs from the ReleaseTitle reported in Cell 10. | Multiple String | C | Beatles for Sale |
20 | ReleaseSubTitleAsReceived | The ReleaseSubTitle as received by the DSP. The ReleaseSubTitleAsReceived shall only be provided if it differs from the ReleaseSubTitle reported in Cell 11. | Multiple String | C | Live Version |
21 | AlternativeReleaseTitle | An alternative title of the Release | Multiple String | O | Beatles for Sale |
22 | AlternativeReleaseTitleAsReceived | The AlternativeReleaseTitle as received by the DSP. The AlternativeReleaseTitleAsReceived shall only be provided if it differs from the AlternativeReleaseTitle reported in Cell 21. | Multiple String | C | Beatles for Sale |
5.4 Resource Record Types
Cell Name | Field Definition | Data Type | M/O/C? | Example | |||
---|---|---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “AS01.02” | Fixed string | M | AS01.02 | ||
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 (updated) | ResourceISRC | The ISRC (International Standard Recording Code as defined in ISO 3901) for the SoundRecording. An ISRC comprises four parts: two characters, followed by three alphanumeric characters, then two digits and five digits. | String | C | USS1Z1412345 | ||
6 | ResourceTitle | The ReferenceTitle of the SoundRecording. | String | M | Bohemian Rhapsody | ||
7 | ResourceSubTitle | A Descriptor which is supplementary to, but not contained within, a ResourceTitle. | String | O | Live Version | ||
8 | ResourceDisplayArtistName | The Name to be used by a DSP when presenting Artist details of the Resource to a Consumer. To be provided if available to the Message Sender. | String | C | Queen | ||
9 | ResourceDisplayArtistPartyId | The PartyId of the DisplayArtist | PartyID | O | ISNI::0000000081266409 | ||
10 | ResourceDuration | 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 ResourceDuration shall be provided if available to the Message Sender. | ISO duration | C | PT1H2M3S | ||
11 | ResourceType | The Type of the Resource | AVS | M | SoundRecording | ||
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 its 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 | ||
13 (new) | IsSubjectTo | A flag indicating whether the Sound Recording described is, in the view of the Message Sender, subject to an ownership conflict. Such a conflict might be detected while generating the sales/usage report, which may (or may not) be the last day of the reporting period. | Boolean | O | false | ||
14 (new) | LastConflictCheck | The date that provides the most recent record the Message Sender has in its system that tells them whether the Sound Recording is in conflict or not. This date may only be provided if IsSubjectToOwnershipConflict is set to true. | ISO Date | C | 2020-07-01 |
Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “AS02.03” | Fixed string | M | AS02.03 |
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 (updated) | ResourceISRC | 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. | Strings | C | USS1Z1412345 |
6 | ResourceTitle | The ReferenceTitle of the SoundRecording. | String | M | Bohemian Rhapsody |
7 | ResourceSubTitle | A Descriptor which is supplementary to, but not contained within, a ResourceTitle. | String | O | Live Version |
8 (updated) | ResourceDisplayArtistName | The Name to be used by a DSP when presenting Artist details of the Resource to a Consumer. This must be provided when available and may be omitted if not available, especially in user-generated content scenarios. | String | C | Queen |
9 | ResourceDisplayArtistPartyId | The PartyId of the DisplayArtist | PartyID | O | ISNI::0000000081266409 |
10 | ResourceDuration | 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 ResourceDuration shall be provided if available to the Message Sender. | ISO duration | C | PT1H2M3S |
11 | ResourceType | The Type of the Resource | AVS | M | SoundRecording |
12 | MusicalWorkISWC | 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. ISWCs have no dashes. MusicalWorkISWC 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 | MusicalWorkComposerAuthorName | The Name of a Writer of the Musical Work used in creating the Resource. MusicalWorkComposerAuthorName 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 MusicalWorkComposerAuthorName and MusicalWorkComposerAuthorPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple String | C | Johann Sebastian Bach |
14 | MusicalWorkComposerAuthorPartyId | The PartyId(s) of the ComposerAuthor(s) The order of the individual strings in MusicalWorkComposerAuthorName and MusicalWorkComposerAuthorPartyId shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one MusicalWorkComposerAuthorPartyId can be provided for each ComposerAuthor. | Multiple PartyID(s) | O | ISNI::0000000081266409 |
15 | MusicalWorkArrangerName | The Name of an Arranger of the Musical Work used in creating the Resource. MusicalWorkArrangerName 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 MusicalWorkArrangerName and MusicalWorkArrangerPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple String | C | August Wilhelmj |
16 | MusicalWorkArrangerPartyId | The PartyId(s) of the Arranger(s) The order of the individual strings in MusicalWorkArrangerName and MusicalWorkArrangerPartyId shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one MusicalWorkArrangerPartyId can be provided for each Arranger. | Multiple PartyID(s) | O | ISNI::0000000081266409 |
17 | MusicPublisherName | The Name of the MusicPublisher(s) of the Musical Work for the relevant Territory. MusicPublisherName 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 MusicPublisherName and MusicPublisherPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple String | C | UMP |
18 | MusicPublisherPartyId | The PartyID(s) of the MusicPublisher(s). The order of the individual strings in MusicPublisherName 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 PartyID | O | ISNI::00000000111111111 |
19 | MusicalWorkContributorName | 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. MusicalWorkContributorName 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 MusicalWorkContributorName and MusicalWorkContributorPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple String | C | UMP |
20 | MusicalWorkContributorPartyId | The PartyId(s) of the MusicalWorkContributor(s) The order of the individual strings in MusicalWorkContributorName and MusicalWorkContributorPartyId shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one MusicalWorkContributorPartyId can be provided for each MusicalWorkContributor. | Multiple PartyID(s) | O | ISNI::0000000081266409 |
21 (updated) | ProprietaryMusicalWorkId | The ProprietaryIdentifier of the Musical Work, preceded by a namespace identifier in the syntax ns::id | Multiple String::String | O | myns::4534 |
22 | 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 its 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 |
23 (new) | IsSubjectTo | A flag indicating whether the Sound Recording described is, in the view of the Message Sender, subject to an ownership conflict. Such a conflict might be detected while generating the sales/usage report, which may (or may not) be the last day of the reporting period. | Boolean | O | false |
24 (new) | LastConflictCheck | The date that provides the most recent record the Message Sender has in its system that tells them whether the Sound Recording is in conflict or not. This date may only be provided if IsSubjectToOwnershipConflict is set to true. | ISO Date | C | 2020-07-01 |
Cell Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “AS03.02” | Fixed string | M | AS03.02 |
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 | ProprietaryResourceId | 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. | AVSs | M | VideoReport |
9 | ResourceTitle | The ReferenceTitle of the audio-visual Resource. | String | M | The Hamburger Postulate |
10 | ResourceSubTitle | A Descriptor which is supplementary to, but not contained within, a ResourceTitle. | String | O | Original Version |
11 | OriginalResourceTitle | A Title given to a Creation by its Creator(s), in its original Language. OriginalResourceTitle 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. Multiple EpisodeNumbers can be provided when agreed between Message Sender and Message Recipient. | Multiple Integer | C | 3 |
14 | ResourceGenre | The genre or style (such as Musical, literary or audio-visual) with which the Resource is associated. | String | O | Horror Comedy |
15 | ResourceDuration | The Duration of the 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 | ResourceProducerName | The Name(s) of the producer(s) of the audio-visual Resource The order of the individual strings in ResourceProducerName and ResourceProducerPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple Strings | O | Scott Kraft |
17 | ResourceProducerPartyId | The PartyId(s) of the Producer(s) The order of the individual strings in ResourceProducerName and ResourceProducerPartyId shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one ResourceProducerPartyId can be provided for each ResourceProducerName. | Multiple PartyID | O | ISNI::0000000081266409 |
18 | ResourceDirectorName | The Name(s) of the director(s) of the audio-visual Resource ResourceDirectorName 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 ResourceDirectorName and ResourceDirectorPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple Strings | C | Mark Cendrowski |
19 | ResourceDirectorPartyId | The PartyId(s) of the Director(s) The order of the individual strings in ResourceDirectorName and ResourceDirectorPartyId shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one ResourceDirectorPartyId can be provided for each ResourceDirectorName. | Multiple PartyID | O | ISNI::0000000081266409 |
20 | ResourceActorName | The Name(s) of the actor(s) of the audio-visual Resource The order of the individual strings in ResourceActorName and ResourceActorPartyId shall be the same so that the recipient is able to relate names and IDs correctly | Multiple Strings | O | Jim Parsons |
21 | ResourceActorPartyId | The PartyId(s) of the Actor(s) The order of the individual strings in ResourceActorName and ResourceActorPartyId 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. | 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 | OriginalLanguageOfPerformance | The main 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. LanguageOfDubbing is mandatory when LanguageLocalizationType is Dubbed, SubTitled or Multilingual. | ISO Language Code | O | de |
27 | DateOfProductionOrRelease | The date when the audio-visual resource was produced, or when it was first released, in the ISO 8601 format: YYYY[-MM[-DD]]. 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 | CountryOfResourceProduction | The country or countries in which the audio-visual resource was produced. CountryOfResourceProduction 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 |
29 | OriginalBroadcastDateTime | The date of the original 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]]. | DateTime | O | 2015-02-05 |
30 (new) | ResourceProductionCompanyName | Name of the company that produced the Resource. | String | O | Production123 |
31 (new) | ResourceProductionCompanyPartyId | The PartyId of the ProductionCompany. | Multiple PartyID | O | ISNI::0000000081266409 |
32 (new) | CueSheetDataProviderName | The Name of the company that provided the Cue Sheet information to the MessageSender. | String | O | UMG |
Cell Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “AS04” | Fixed string | M | AS04 |
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 | ResourceType | The Type of the Resource. The only valid values are Image, SoundRecording and Text | AVS | M | Image |
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) in accordance with the Basic Audio Profile to The Mechanical Licensing Collective. This specifically also includes music videos.
Cell Name | Field Definition | Data Type | M/O/C? | Example | |||
---|---|---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “AS05” | Fixed string | M | AS05 | ||
2 | BlockId | The Identifier (specific to the Message) of the Block that this Record belongs to. All Records in a single Block shall have the same BlockId | String | M | 7 | ||
3 | ResourceReference | The Identifier (specific to the Block) of the Record, that allows other Records to reference this Record | String | M | 15 | ||
4 | DspResourceId | The ProprietaryIdentifier of the Resource assigned by the MessageSender | String | M | 12345678 | ||
5 | ISRC | The ISRC (International Standard Recording Code as defined in ISO 3901) for the SoundRecording. An ISRC comprises four parts: two characters, followed by three alphanumeric characters, then two digits and five digits. | String | C | USS1Z1412345 | ||
6 | ResourceTitle | The Title of the SoundRecording as displayed to the consumer. | String | M | Bohemian Rhapsody | ||
7 | ResourceSubTitle | A Descriptor which is supplementary to, but not contained within, a ResourceTitle. | String | O | Live Version | ||
8 | ResourceDisplayArtistName | The Name used by the DSP when presenting Artist details of the Resource to a Consumer. To be provided if available to the Message Sender. Information on DisplayArtistNames and DisplayArtists can be found on the DDEX Knowledge Base (kb.ddex.net). | String | C | Queen | ||
9 | ResourceDisplayArtistPartyId | The PartyId of the DisplayArtist | PartyID | O | ISNI::0000000081266409 | ||
10 | ResourceDuration | 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 ResourceDuration shall be provided if available to the Message Sender. | ISO duration | C | PT1H2M3S | ||
11 | ResourceType | The Type of the Resource | AVS | M | SoundRecording | ||
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 its 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 | ||
13 | IsSubjectTo | A flag indicating whether the Sound Recording described is, in the view of the Message Sender, subject to an ownership conflict. Such a conflict might be detected while generating the sales/usage report, which may (or may not) be the last day of the reporting period. | Boolean | O | false | ||
14 | LastConflictCheck | The date that provides the most recent record the Message Sender has in its system that tells them whether the Sound Recording is in conflict or not. This date may only be provided if IsSubjectToOwnershipConflict is set to true. | ISO Date | C | 2020-07-01 | ||
15 | ResourceStudioProducerName | The Name of the Party who directs, and has overall creative and technical oversight of, the entire recording project and the individual recording sessions that are a part of the project. The StudioProducer participates in and/or supervises the recording session and works directly with the Artist, Musicians and Engineers. The order of the individual strings in ResourceStudioProducerName and ResourceStudioProducerPartyId shall be the same so that the Message Recipient is able to relate names and IDs correctly. | Multiple string | O | Alan Parsons | ||
16 | ResourceStudioProducerPartyId | The PartyId of the StudioProducer. The order of the individual strings in ResourceStudioProducerName and ResourceStudioProducerPartyId shall be the same so that the Message Recipient is able to relate names and IDs correctly. Only one ResourceStudioProducerPartyId may be provided for each ResourceStudioProducerName. | Multiple PartyID(s) | O | ISNI::0000000081266409 | ||
17 | AlternativeResourceTitle | An alternative title of the Resource | Multiple Strings | O | Mad4You|Mad 4 You | ||
18 | ResourceDisplayArtistNameAsReceived | The ResourceDisplayArtistName as received by the DSP. The ResourceDisplayArtistNameAsReceived shall only be provided if it differs from the ResourceDisplayArtistName reported in Cell 8. Information on DisplayArtistNames and DisplayArtists can be found on the DDEX Knowledge Base (kb.ddex.net). | Multiple String | C | Coldplay vs Swedish House Mafia | ||
19 | ResourceDisplayArtistAsReceived | The DisplayArtist information as received by the DSP. Information on DisplayArtistNames and DisplayArtists can be found on the DDEX Knowledge Base (kb.ddex.net). | Multiple String | C | Coldplay vs Swedish House Mafia | ||
20 | ResourceTitleAsReceived | The ResourceTitle as received by the DSP. The ResourceTitleAsReceived shall only be provided if it differs from the ResourceTitle reported in Cell 6. | Multiple String | C | Bohemian Rhapsody | ||
21 | ResourceSubTitleAsReceived | The ResourceSubTitle as received by the DSP. The ResourceSubTitleAsReceived shall only be provided if it differs from the ResourceSubTitle reported in Cell 7. | Multiple String | C | Live Version | ||
22 | AlternativeResourceTitleAsReceived | The AlternativeResourceTitle as received by the DSP. The AlternativeResourceTitleAsReceived shall only be provided if it differs from the AlternativeResourceTitle reported in Cell 17. | Multiple Strings | C | Mad4You|Mad 4 You | ||
23 | ResourceIngestionDate | The date when the Resource was initially received by the DSP and when it has been ingested into its systems. One of ResourceIngestionDate, EstimatedResourceIngestionDate, ResourceAvailabilityDate and ResourceEstimatedAvailabilityDate shall be provided. | ISO Date | C | 2020-01-17 | ||
24 | EstimatedResourceIngestionDate | An estimation of the date when the Resource was initially received by the DSP and when it has been ingested into its systems. One of ResourceReceptionDate, EstimatedResourceReceptionDate, ResourceAvailabilityDate and ResourceEstimatedAvailabilityDate shall be provided. | ISO Date | C | 2020-01-30 | ||
25 | ResourceAvailabilityDate | The date when the Resource was initially made available to consumers by the DSP. One of ResourceReceptionDate, EstimatedResourceReceptionDate, ResourceAvailabilityDate and ResourceEstimatedAvailabilityDate shall be provided. | ISO Date | C | 2020-01-17 | ||
25 | EstimatedResourceAvailabilityDate | An estimation of the date when the Resource was initially made available to consumers by the DSP. One of ResourceReceptionDate, EstimatedResourceReceptionDate, ResourceAvailabilityDate and ResourceEstimatedAvailabilityDate shall be provided. | ISO Date | C | 2020-01-30 |
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) in accordance with the Basic Audio Profile to The Mechanical Licensing Collective. This specifically also includes music videos.
Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “AS06” | Fixed string | M | AS06 |
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 | ResourceISRC | 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. | Strings | C | USS1Z1412345 |
6 | ResourceTitle | The Title of the SoundRecording as displayed to the consumer. | String | M | Bohemian Rhapsody |
7 | ResourceSubTitle | A Descriptor which is supplementary to, but not contained within, a ResourceTitle. | String | O | Live Version |
8 | ResourceDisplayArtistName | The Name used by the DSP when presenting Artist details of the Resource to a Consumer. This must be provided when available and may be omitted if not available, especially in user-generated content scenarios. Information on DisplayArtistNames and DisplayArtists can be found on the DDEX Knowledge Base (kb.ddex.net). | String | C | Queen |
9 | ResourceDisplayArtistPartyId | The PartyId of the DisplayArtist | PartyID | O | ISNI::0000000081266409 |
10 | ResourceDuration | 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 ResourceDuration shall be provided if available to the Message Sender. | ISO duration | C | PT1H2M3S |
11 | ResourceType | The Type of the Resource | AVS | M | SoundRecording |
12 | MusicalWorkISWC | 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. ISWCs have no dashes. MusicalWorkISWC 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 | MusicalWorkComposerAuthorName | The Name of a Writer of the Musical Work used in creating the Resource. MusicalWorkComposerAuthorName 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 MusicalWorkComposerAuthorName and MusicalWorkComposerAuthorPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple String | C | Johann Sebastian Bach |
14 | MusicalWorkComposerAuthorPartyId | The PartyId(s) of the ComposerAuthor(s) The order of the individual strings in MusicalWorkComposerAuthorName and MusicalWorkComposerAuthorPartyId shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one MusicalWorkComposerAuthorPartyId can be provided for each ComposerAuthor. | Multiple PartyID(s) | O | ISNI::0000000081266409 |
15 | MusicalWorkArrangerName | The Name of an Arranger of the Musical Work used in creating the Resource. MusicalWorkArrangerName 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 MusicalWorkArrangerName and MusicalWorkArrangerPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple String | C | August Wilhelmj |
16 | MusicalWorkArrangerPartyId | The PartyId(s) of the Arranger(s) The order of the individual strings in MusicalWorkArrangerName and MusicalWorkArrangerPartyId shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one MusicalWorkArrangerPartyId can be provided for each Arranger. | Multiple PartyID(s) | O | ISNI::0000000081266409 |
17 | MusicPublisherName | The Name of the MusicPublisher(s) of the Musical Work for the relevant Territory. MusicPublisherName 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 MusicPublisherName and MusicPublisherPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple String | C | UMP |
18 | MusicPublisherPartyId | The PartyID(s) of the MusicPublisher(s). The order of the individual strings in MusicPublisherName 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 PartyID | O | ISNI::00000000111111111 |
19 | MusicalWorkContributorName | 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. MusicalWorkContributorName 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 MusicalWorkContributorName and MusicalWorkContributorPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple String | C | UMP |
20 | MusicalWorkContributorPartyId | The PartyId(s) of the WorkContributor(s) The order of the individual strings in MusicalWorkContributorName and MusicalWorkContributorPartyId shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one MusicalWorkContributorPartyId can be provided for each MusicalWorkContributor. | Multiple PartyID(s) | O | ISNI::0000000081266409 |
21 | ProprietaryMusicalWorkId
| The ProprietaryIdentifier of the Musical Work, preceded by a namespace identifier in the syntax ns::id | Multiple String::String | O | myns::4534 |
22 | 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 its 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 |
23 | IsSubjectTo | A flag indicating whether the Sound Recording described is, in the view of the Message Sender, subject to an ownership conflict. Such a conflict might be detected while generating the sales/usage report, which may (or may not) be the last day of the reporting period. | Boolean | O | false |
24 | LastConflictCheck | The date that provides the most recent record the Message Sender has in its system that tells them whether the Sound Recording is in conflict or not. This date may only be provided if IsSubjectToOwnershipConflict is set to true. | ISO Date | C | 2020-07-01 |
25 | ResourceStudioProducerName | The Name of the Party who directs, and has overall creative and technical oversight of, the entire recording project and the individual recording sessions that are a part of the project. The StudioProducer participates in and/or supervises the recording session and works directly with the Artist, Musicians and Engineers. The order of the individual strings in ResourceStudioProducerName and ResourceStudioProducerPartyId shall be the same so that the Message Recipient is able to relate names and IDs correctly. | Multiple string | O | Alan Parsons |
26 | ResourceStudioProducerPartyId | The PartyId of the StudioProducer. The order of the individual strings in ResourceStudioProducerName and ResourceStudioProducerPartyId shall be the same so that the Message Recipient is able to relate names and IDs correctly. Only one ResourceStudioProducerPartyId may be provided for each ResourceStudioProducerName. | Multiple PartyID(s) | O | ISNI::0000000081266409 |
27 | AlternativeResourceTitle | An alternative title of the Resource. | Multiple Strings | O | Mad4You|Mad 4 You |
28 | MusicalWorkTitle | The ReferenceTitle of the Musical Work. The MusicalWorkTitle shall only be provided if it differs from the ResourceTitle. | String | C | Bohemian Rhapsody |
29 | MusicalWorkSubTitle | A Descriptor which is supplementary to, but not contained within, the MusicalWorkTitle. | String | O | Piano version |
30 | ResourceTitleAsReceived | The Title of the Resource as received by the DSP. The ResourceTitleAsReceived shall only be provided if it differs from the ResourceTitle reported in Cell 6. | Multiple String | C | Bohemian Rhapsody |
31 | ResourceSubTitleAsReceived | The SubTitle of the Resource as received by the DSP. The ResourceSubTitleAsReceived shall only be provided if it differs from the ResourceSubTitle reported in Cell 7.
| Multiple String | C | Live Version |
32 | AlternativeResourceTitleAsReceived | The AlternativeResourceTitle as received by the DSP. The AlternativeResourceTitleAsReceived shall only be provided if it differs from the AlternativeResourceTitle reported in Cell 27. | Multiple Strings | C | Mad4You|Mad 4 You |
33 | ResourceDisplayArtistNameAsReceived | The ResourceDisplayArtistName as received by the DSP. The DisplayArtistNameAsReceived shall only be provided if it differs from the ResourceDisplayArtistName reported in Cell 8. Information on DisplayArtistNames and DisplayArtists can be found on the DDEX Knowledge Base (kb.ddex.net). | Multiple String | C | Coldplay vs Swedish House Mafia |
34 | ResourceDisplayArtistAsReceived | The DisplayArtist information as received by the DSP. Information on DisplayArtistNames and DisplayArtists can be found on the DDEX Knowledge Base (kb.ddex.net). | Multiple String | C | Coldplay vs Swedish House Mafia |
35 | AlternativeMusicalWorkTitle | An alternative Title of the MusicalWork. | Multiple Strings | O | Mad4You|Mad 4 You |
36 | ResourceIngestionDate | The date when the Resource was initially received by the DSP and when it has been ingested into its systems. One of ResourceIngestionDate, EstimatedResourceIngestionDate, ResourceAvailabilityDate and ResourceEstimatedAvailabilityDate shall be provided. | ISO Date | C | 2020-01-17 |
37 | EstimatedResourceIngestionDate | An estimation of the date when the Resource was initially received by the DSP and when it has been ingested into its systems. One of ResourceReceptionDate, EstimatedResourceReceptionDate, ResourceAvailabilityDate and ResourceEstimatedAvailabilityDate shall be provided. | ISO Date | C | 2020-01-30 |
38 | ResourceAvailabilityDate | The date when the Resource was initially made available to consumers by the DSP. One of ResourceReceptionDate, EstimatedResourceReceptionDate, ResourceAvailabilityDate and ResourceEstimatedAvailabilityDate shall be provided. | ISO Date | C | 2020-01-17 |
39 | EstimatedResourceAvailabilityDate | An estimation of the date when the Resource was initially made available to consumers by the DSP. One of ResourceReceptionDate, EstimatedResourceReceptionDate, ResourceAvailabilityDate and ResourceEstimatedAvailabilityDate shall be provided. | ISO Date | C | 2020-01-30 |
The LC01 record has the same structure as the AS02 Record with two differences: The RecordType is “LC01” and all Cells other than Record Type, BlockID and ResourceReference are optional.
Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “LC01” | Fixed string | M | LC01 |
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 | O | 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. | Multiple Strings | O | USS1Z1412345 |
6 | ResourceTitle | The ReferenceTitle of the SoundRecording. | String | O | Bohemian Rhapsody |
7 | ResourceSubTitle | A Descriptor which is supplementary to, but not contained within, a ResourceTitle. | String | O | Live Version |
8 | ResourceDisplayArtistName | The Name to be used by a DSP when presenting Artist details of the Resource to a Consumer. | String | O | Queen |
9 | ResourceDisplayArtistPartyId | The PartyId of the DisplayArtist | PartyID | O | ISNI::0000000081266409 |
10 | ResourceDuration | 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). | ISO duration | O | PT1H2M3S |
11 | ResourceType | The Type of the Resource | AVS | O | SoundRecording |
12 | MusicalWorkISWC | 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. ISWCs have no dashes. | String | O | T0030749586 |
13 | MusicalWorkComposerAuthorName | The Name of a Writer of the Musical Work used in creating the Resource. | Multiple String | O | Johann Sebastian Bach |
14 | MusicalWorkComposerAuthorPartyId | The PartyId(s) of the ComposerAuthor(s) The order of the individual strings in MusicalWorkComposerAuthor and MusicalWorkComposerAuthorPartyId shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one MusicalWorkComposerAuthorPartyId can be provided for each ComposerAuthor. | Multiple PartyID(s) | O | ISNI::0000000081266409 |
15 | MusicalWorkArrangerName | The Name of an Arranger of the Musical Work used in creating the Resource. | Multiple String | O | August Wilhelmj |
16 | MusicalWorkArrangerPartyId | The PartyId(s) of the Arranger(s) The order of the individual strings in MusicalWorkArranger and MusicalWorkArrangerPartyId shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one MusicalWorkArrangerPartyId can be provided for each Arranger. | Multiple PartyID(s) | O | ISNI::0000000081266409 |
17 | MusicPublisherName | The Name of the MusicPublisher(s) of the Musical Work for the relevant Territory. | Multiple String | O | UMP |
18 | MusicPublisherPartyId | 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 PartyID | O | ISNI::00000000111111111 |
19 | MusicalWorkContributorName | The Name of a contributor of the Work. This Cell shall only be used if the Message Sender does not know whether the contributor is a ComposerAuthor or an Arranger, or if the contributor played a role other than a ComposerAuthor or Arranger. | Multiple String | O | UMP |
20 | MusicalWorkContributorPartyId | The PartyId(s) of the WorkContributor(s) The order of the individual strings in MusicalWorkContributorName and MusicalWorkContributorPartyId shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one MusicalWorkContributorPartyId can be provided for each WorkContributor. | Multiple PartyID(s) | O | ISNI::0000000081266409 |
21 | ProprietaryMusicalWorkId | The ProprietaryIdentifier of the Musical Work, preceded by a namespace identifier in the syntax ns::id | Multiple String::String | O | myns::4534 |
22 | DataProviderName | The Name of the company that provided the MusicalWork information to the MessageSender. | String | O | UMG |
23 | IsSubjectTo OwnershipConflict | A flag indicating whether the relevant Rights Controller has made an ownership claim for the sound recording described in the LC record. | Boolean | O | false |
5.5. Work and Cue Record Types
Cell Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “MW01.02” | Fixed string | M | MW01.02 |
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 | DspMusicalWorkId | The ProprietaryIdentifier of the Musical Work assigned by the MessageSender | String | M | 12345678 |
4 | MusicalWorkISWC | 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. ISWCs have no dashes. MusicalWorkISWC 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 | MusicalWorkTitle | The ReferenceTitle of the Musical Work | String | M | Bohemian Rhapsody |
6 | MusicalWorkSubTitle | A Descriptor which is supplementary to, but not contained within, a MusicalWorkTitle. | String | O | Live version |
7 | MusicalWorkComposerAuthorName | The Name of a Writer of the Musical Work used in creating the Resource. MusicalWorkComposerAuthorName 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 MusicalWorkComposerAuthorName and MusicalWorkComposerAuthorPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple String | C | Johann Sebastian Bach |
8 | MusicalWorkComposerAuthorPartyId | The PartyId(s) of the ComposerAuthor(s) The order of the individual strings in MusicalWorkComposerAuthorName and MusicalWorkComposerAuthorPartyId shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one MusicalWorkComposerAuthorPartyId can be provided for each ComposerAuthor. | Multiple PartyID(s) | O | ISNI::0000000081266409 |
9 | MusicalWorkArrangerName | The Name of an Arranger of the Musical Work used in creating the Resource. MusicalWorkArrangerName 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 MusicalWorkArrangerName and MusicalWorkArrangerPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple String | C | August Wilhelmj |
10 | MusicalWorkArrangerPartyId | The PartyId(s) of the Arranger(s) The order of the individual strings in MusicalWorkArrangerName and MusicalWorkArrangerPartyId shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one MusicalWorkArrangerPartyId can be provided for each Arranger. | Multiple PartyID(s) | O | ISNI::0000000081266409 |
11 | MusicPublisherName | The Name of the MusicPublisher(s) of the Musical Work for the relevant Territory. MusicPublisherName 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 MusicPublisherName and MusicPublisherPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple String | C | UMP |
12 | MusicPublisherPartyId | The PartyID(s) of the MusicPublisher(s). The order of the individual strings in MusicPublisherName 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 PartyID | O | ISNI::00000000111111111 |
13 | MusicalWorkContributorName | 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. MusicalWorkContributorName 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 MusicalWorkContributorName and MusicalWorkContributorPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple String | C | UMP |
14 | MusicalWorkContributorPartyId | The PartyId(s) of the MusicalWorkContributor(s) The order of the individual strings in MusicalWorkContributorName and MusicalWorkContributorPartyId shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one MusicalWorkContributorPartyId can be provided for each MusicalWorkContributor. | Multiple PartyID(s) | O | ISNI::0000000081266409 |
15 | DataProviderName | The Name of the company that provided the MusicalWork information to the MessageSender. | String | O | UMG |
16 | ProprietaryMusicalWorkId | The ProprietaryIdentifier of the Work, preceded by a namespace identifier in the syntax ns::id | Multiple String::String | O | myns::4534 |
17 (new) | ResourceReference
| The Resource within a Release for which additional Musical Work information is provided. ResourceReference must be provided in the Masterlist Profile when Resources are reported as part of a Release. | String | C | 6 |
18 (new) | ParentLicensorDataRecordId | The Identifier (specific to the Message) of the LI01 Record that this Musical Work record provides additional data to. This ParentLicensorDataRecordId shall only be used where the MW01 Record provides data to an LI01 Masterlist Record. | String | C | 123 |
19 (new) | ParentMasterlistId | The Identifier (specific to the Message) of the Master Record that this Musical Work record provides additional data to. This ParentMasterlistId shall only be used where the MW01 Record provides data to an ML01 Masterlist Record. | String | C | 123 |
This is the basic Record to describe a Musical Work that has been utilised in accordance with the Basic Audio Profile to The Mechanical Licensing Collective.
Cell Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “MW02” | Fixed string | M | MW02 |
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 | MusicalWorkISWC | 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. ISWCs have no dashes. MusicalWorkISWC 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 | MusicalWorkTitle | The ReferenceTitle of the Musical Work | String | M | Bohemian Rhapsody |
6 | MusicalWorkSubTitle | A Descriptor which is supplementary to, but not contained within, a MusicalWorkTitle. | String | O | Live version |
7 | MusicalWorkComposerAuthorName | The Name of a Writer of the Musical Work used in creating the Resource. MusicalWorkComposerAuthorName 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 MusicalWorkComposerAuthorName and MusicalWorkComposerAuthorPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple String | C | Johann Sebastian Bach |
8 | MusicalWorkComposerAuthorPartyId | The PartyId(s) of the MusicalWorkComposerAuthor(s) The order of the individual strings in MusicalWorkComposerAuthorName and MusicalWorkComposerAuthorPartyId shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one MusicalWorkComposerAuthorPartyId can be provided for each ComposerAuthor. | Multiple PartyID(s) | O | ISNI::0000000081266409 |
9 | MusicalWorkArrangerName | The Name of an Arranger of the Musical Work used in creating the Resource. MusicalWorkArrangerName 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 MusicalWorkArranger and MusicalWorkArrangerPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple String | C | August Wilhelmj |
10 | MusicalWorkArrangerPartyId | The PartyId(s) of the Arranger(s) The order of the individual strings in MusicalWorkArrangerName and MusicalWorkArrangerPartyId 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) | O | ISNI::0000000081266409 |
11 | MusicPublisherName | The Name of the MusicPublisher(s) of the Musical Work for the relevant Territory. MusicPublisherName 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 MusicPublisherName and MusicPublisherPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple String | C | UMP |
12 | MusicPublisherPartyId | The PartyID(s) of the MusicPublisher(s). The order of the individual strings in MusicPublisherName 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 PartyID | O | ISNI::00000000111111111 |
13 | MusicalWorkContributorName | 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. MusicalWorkContributorName 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 MusicalWorkContributorName and MusicalWorkContributorPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple String | C | UMP |
14 | MusicalWorkContributorPartyId | The PartyId(s) of the WorkContributor(s) The order of the individual strings in MusicalWorkContributorName and MusicalWorkContributorPartyId shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one MusicalWorkContributorPartyId can be provided for each MusicalWorkContributor. | Multiple PartyID(s) | O | ISNI::0000000081266409 |
15 | DataProviderName | The Name of the company that provided the MusicalWork information to the MessageSender. | String | O | UMG |
16 | ProprietaryWorkId | The ProprietaryIdentifier of the Work, preceded by a namespace identifier in the syntax ns::id | Multiple String::String | O | myns::4534 |
17 | ResourceReference
| The Resource within a Release for which additional Musical Work information is provided. ResourceReference must be provided in the Masterlist Profile when Resources are reported as part of a Release. | String | C | 6 |
18 | ParentLicensorDataRecordId | The Identifier (specific to the Message) of the LI01 Record that this Musical Work record provides additional data to. This ParentLicensorDataRecordId shall only be used where the MW01 Record provides data to an LI01 Masterlist Record. | String | C | 123 |
19 | ParentMasterlistId | The Identifier (specific to the Message) of the Master Record that this Musical Work record provides additional data to. This ParentMasterlistId shall only be used where the MW01 Record provides data to an ML01 Masterlist Record. | String | C | 123 |
20 | MusicalWorkReference | The Identifier (specific to the Block) of the Record, that allows other Records to reference this Record. MusicalWorkWorkReference must be provided if an RC01 Record provides additional information about the Work described in this Record. | String | C | 46 |
21 | AlternativeMusicalWorkTitle | An alternative Title of the MusicalWork. | Multiple Strings | O | Mad4You|Mad 4 You |
This Record provides details about Cues of Creations used in video Resources that are part of an audio-visual Release.
Cell Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “CU01.01” | Fixed string | M | CU01.01 |
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 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”. ISWCs have no dashes. | 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 | ReferencedCreation | 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 | ReferencedCreation | 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 | ReferencedCreation | 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 | ReferencedCreation | The PartyId of the ReferencedCreationContributor. 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 | ReferencedCreation | 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 | ReferencedCreation | 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 | ReferencedCreation | 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 | ReferencedCreation | 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 |
17 (new) | CueSheetDataProviderName | The Name of the company that provided the Cue Sheet information to the MessageSender. | String | O | UMG |
This Record provides details about Cues of Creations used in video Resources that are part of an audio-visual Release.
Cell Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “CU02” | Fixed string | M | CU02 |
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 describing the Resource for which the Cue is reported reported. | String | M | 4 |
4 | DspWorkId | The ProprietaryIdentifier of the Work assigned by the MessageSender. | String | M | 2134235243 |
5 | ProprietaryWorkId | Complementary Identifier(s) of the Work This field can be prefixed with a reference code. ProprietaryWorkId 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”. | MultiString | C | GETTY::P15423890432|ref::1548934566 |
6 | WorkTitle | The ReferenceTitle of the Work | String | M | Stade de France |
7 | WorkType | The Type of the Work. | AVS | M | LiteraryWork |
8 | CreationOrReleaseDate | The date when the image resource was created, or when it was first released, in the ISO 8601 format: YYYY[-MM[-DD]]. CreationOrReleaseDate is mandatory when available to the MessageSender | ISO date | C | 1995 |
9 | WorkContributorName | The Name of a Contributor of the Work used. The order of the individual strings in WorkContributorName and WorkContributorId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple strings | M | Michel Macary |
10 | WorkContributorPartyId | The PartyId of the WorkContributor. The order of the individual strings in WorkContributorName and WorkContributorId shall be the same so that the recipient is able to relate names and IDs correctly; a maximum of one WorkContributorId can be provided for each WorkContributor. | Multiple PartyID | O | ISNI::0000000081266409 |
11 | WorkContributorRole | Role of the Work Contributor | Multiple AVS | M | Architect |
12 | BroadcastStartTime | The time of the broadcast of the Work used in ISO 8601 format To be filled depending on the type of Work | ISO8601 | C | T01:03:00Z |
13 | BroadcastDuration
| The Duration of the broadcast of the Work used in ISO 8601 format To be filled depending on the type of Work | ISO duration | C | PT2M5S |
14 | LengthOfText | Number of characters of the text used To be provided depending on the type of Work. Only to be provided if text is not presented as part of an audio-visual Resource (e.g. as text on a website). | String | C | 1500 |
15 | LanguageAndCharacterCoding | Language and character code used for the text To be provided if LengthOfText is provided. | String | C | fr |
16 | WorkPublisherName | The Name of the Publisher of the Work Publisher name 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 | Galimard |
17 | WorkPublisherId | The PartyId of the Publisher | String | O | ISNI::000000007654345 |
18 | WorkProducerName | The Name of the Producer of the Work | String | O | FTVStudio |
19 | WorkProducerId | The PartyId of the Producer | String | O | ISNI::00000000352444 |
Cell Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “RC01” | Fixed string | M | RC01 |
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 describing the Resource for which the Cue is reported. ResourceReference or WorkReference must be provided | String | C | 4 |
4 | MusicalWorkReference | The Musical Work for which RightsController information is provided. ResourceReference or MusicalWorkReference must be provided. | String | C | 46 |
5 | RightsControllerName | Name of the RightsController that is believed by the MessageSender to control a RightShare of the referenced Work. The order of the individual strings in RightsControllerName and RightsControllerPartyId shall be the same so that the Message Recipient is able to relate names and IDs correctly. | String | M | BMG |
6 | RightsControllerPartyId | The PartyId of the RightsController. The order of the individual strings in RightsControllerName and RightsControllerPartyId shall be the same so that the Message Recipient is able to relate names and IDs correctly. | Multiple PartyIds | O | ISNI::0000000081266409 |
7 | RightsType | The RightsType for which the RightShare% is reported. RightsType and RightShare% must always be provided together. | AVS | C | MechanicalRight |
6 | RightShare% | The percentage that is believed to be claimed by the RightsController for the relevant RightsType. The RightShare% shall be provided as a Decimal between 0 and 100. RightsType and RightShare% must always be provided together. | Decimal | C | 33.33 |
7 | IsAffiliatedWithLicensee | The flag indicating whether the reporting Licensee, or a company affiliated with the reporting Licensee, is the same as the RightsController referenced in Cells 5 and/or 6. | Boolean | M | False |
5.6 Record Types to provide Sales and/or Usage Data
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 Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “SU01.02” | Fixed string | M | SU01.02 |
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 | 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 ResourceReference 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 | 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 | PriceConsumerPaid | 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 |
13 (new) | 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 must be provided when there is no UseType on the relevant Summary Record. It may not be provided when there is a UseType on the relevant Summary Record. | AVS | C | PermanentDowload |
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 Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “SU02.02” | Fixed string | M | SU02.02 |
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 | 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 ResourceReference 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 | 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. | Decimal | M | 1000 |
9 | PriceConsumerPaid | 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 |
11 (new) | 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 must be provided when there is no UseType on the relevant Summary Record. It may not be provided when there is a UseType on the relevant Summary Record | AVS | C | PermanentDowload |
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 Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “SU03.02” | Fixed string | M | SU03.02 |
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 |
4 | SummaryRecordId | The Identifier (specific to the Message) of the Summary Record that this Usage, Revenue or Sales Record provides details for. SummaryRecordId must not be provided if the SU03.02 Record is followed by a more specific, typically Licensor-specific, Sales/Usage Record (where a SummaryRecordId is provided). SummaryRecordId must be provided if the SU03.02 Record is not followed by a more specific, typically Licensor-specific, Sales/Usage Record (where a SummaryRecordId is provided). | String | C | 34 |
5 | DspResourceId | The ProprietaryIdentifier of the UGC Resource 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. | Decimal | M | 400.25 |
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 |
10 | ContentCategory | A string categorising the content that has been used or distributed as agreed between sender and recipient. | String | O | Music |
11 | 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 |
Cell Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “SU04.02” | Fixed string | M | SU04.02 |
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 ResourceReference 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 (updated) | IsDrmEnforced | The Flag to indicate if the Release was technically protected or not. IsDrmEnforced 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”. | Boolean | C | false |
8 | VideoDefinitionType | The type of resolution (or definition) in which a Video is provided. VideoDefinitionType 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 | PriceConsumerPaid | 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 | |
23 | OriginalBroadcastDateTime | The original broadcast of the Release as part of a Video-on-Demand service (i.e. not the very first time the Release was broadcast). | ISO DateTime | O | 2016-01-26T15:00:00Z |
24 (new) | 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 must be provided when there is no UseType on the relevant Summary Record. It may not be provided when there is a UseType on the relevant Summary Record | AVS | C | PermanentDowload |
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 Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “SU05.01” | Fixed string | M | SU05.01 |
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). Note: in SY08 the equivalent Cell is called ListenerHours with a data type of Decimal. | Duration | O | PT1H5M66S |
10 (new) | 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 must be provided when there is no UseType on the relevant Summary Record. It may not be provided when there is a UseType on the relevant Summary Record | AVS | C | PermanentDowload |
Cell Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “SU06” | Fixed string | M | SU06 |
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. | String | M | 34456 |
5 | TransactedResource | The Block-specific ResourceReference of the Record describing the Resource whose usages, Revenues or Sales are being reported. | String | C | 2345 |
6 | 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 |
7 | OfferURL | The URL from where the Release transacted was available | String | O |
Cell Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “RU01.02” | Fixed string | M | RU01.02 |
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 | DspReleaseId | The ProprietaryIdentifier of the UGC Release assigned by the MessageSender. Based on bilateral agreements, this may not be a complete list of all UGC Releases that have been used. | 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 |
6 | ContentCategory | A string categorising the content that has been used or distributed as agreed between sender and recipient. | String | M | Music |
7 (new) | ParentResourceReference | The ResourceReference for the parent ASxx Record. | String | M | 35 |
Cell Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “RU02.02” | Fixed string | M | RU02.02 |
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 | 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 | |
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 |
8 | ContentCategory | A string categorising the content that has been used or distributed as agreed between sender and recipient. | String | O | Music |
9 (new) | ParentResourceReference | The ResourceReference for the parent ASxx Record. | String | M | 35 |
Cell Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “LI01.03” | Fixed string | M | LI01.03 |
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 | 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 |
5 | RightsControllerPartyId | The 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 |
8 | RightsType | The right for which the RightShare% is provided | AVS | O | MechanicalRight |
9 (updated) | AllocatedNetRevenue | Net Revenue generated that is to be allocated to the MessageRecipient/RightsController in the CurrencyOfTransaction. AllocatedNetRevenue shall be provided based on the contractual relationship between Licensee and Licensor. | Decimal | C | 34567 |
10 (updated) | AllocatedAmount | The amount due to the RighsController for the Uses, Revenue or Sales as reported in this Block AllocatedAmount shall be provided based on the contractual relationship between Licensee and Licensor. | Decimal | C | 2560.77 |
11 | AllocatedUsages | The number of Usages allocated to the RightsController. | Decimal | O | 10.5 |
12 (new) | ParentSalesTransactionId | The SalesTransactionId for the parent sales transaction. | String | M | 34 |
13 (new) | LicensorDataRecordId | The Identifier (specific to the Message) of the LI01 Record that can be used by other Records to provide details to LI Record. | String | M | 123 |
Cell Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “ST01” | Fixed string | M | ST01 |
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 | ParentSalesTransactionId | The SalesTransactionId for the parent sales transaction. | String | M | 34 |
4 | SummaryRecordId | The Identifier (specific to the Message) of the Summary Record containing a specific SubscriberType that this Usage, Revenue or Sales Record provides details for. | String | M | 34 |
5 | Usages | The number of Usages of the Resource or Work that was provided to Consumers, including any sales adjustments. Sales adjustments include e.g. file failures. | Integer | M | 400 |
Note: the ST01 Record Type does not provide financial information and, as such should not be used to calculate royalties. As a consequence, the ST01 Record Type does not have a Cell uniquely identifying an ST01 Record in a sales/usage report. It is possible however, to uniquely identify a specific ST01 Record through the combination of ParentSalesTransactionId and SummaryRecordId or ParentSalesTransactionId and SubscriberType.
5.7 Miscellaneous Record Types
Cell Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “ML01.01”. | Fixed string | M | ML01.01 |
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 Masterlist message provides details for. | String | M | 34 |
4 | ResourceReference | The Resource within a Release for which additional Musical Work information is is being provided. ResourceReference must be provided in the Masterlist Profile when Resources are being reported as part of a Release. | String | C | 7 |
5 | UsageForPrioritisation | The number of Usages of the Resource or Musical Work that is either expected by the Licensee based on previous sales/reporting periods' usages or that have already occurred. UsageForPrioritisation have to be provided if such information is available, based on bilateral agreements. This information is intended to aid the Message Recipient to prioritise handling the information provided in the report. | Integer | C | 400 |
6 | PercentileForPrioritisation | The percentile of usage in which the Licensee either expects this Resource to appear, based on an estimation of its use compared to the sum of all the views for all the "active" Resources in the Sales Context provided via the referenced Summary Record, or based on usages that have already occurred. It is an integer value that ranges from 0 to 100. PercentileForPrioritisation has to be provided if such information is available based on bilateral agreements. | Integer | C | 5 |
7 | UnclaimedPercentage | The RightShare percentage of the Musical Work not claimed at the time listed in the MessageCreatedDateTime in the Message Header as assumed by the Message Sender. | Decimal | O | 33.33 |
8 (new) | MasterlistId | The Identifier (specific to the Message) of the Masterlist Record that can be used by other Records to provide details to the Masterlist Record | String | M | 123 |
One reason for supporting Deal-specific Records is to allow the DSR standard to be used to exchange information where sender and recipient are reluctant to share even the structure, i.e. the Cell names, with their competitors. Companies are strongly encouraged, however, to contact DDEX as soon as this confidentiality requirement ceases to exist, with a view to DDEX developing a standardised approach to the Deal-specific requirement and publishing a suitable new (or revised) Record Type.
The DExx
Record Types can be used as Summary Records as well as Records within a Block .
The DExx
Record Types are signalled by using, in the first Cell, the fixed string DExx
with xx being a unique two digit-ID (e.g. 01, 02, 43, ...) as agreed between sender and recipient.
Senders and recipients are strongly encouraged to not attempt use these Record Types.
5.8 Record Types for Single Record Block Variants
Cell Name | Field Definition | Data Type | M/O/C | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “SR01.01” | Fixed String | M | SR01.01 |
2 | SummaryRecordId | The Identifier (specific to the Message) of the Summary Record that this Usage, Revenue or Sales Record provides details for. | String | M | 22 |
3 | DspResourceId | The ProprietaryIdentifier of the Resource assigned by the MessageSender | String | M | 12345678 |
4 | 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 |
5 | ResourceTitle | The ReferenceTitle of the Resource | String | M | Eight Days a Week |
6 | ResourceSubTitle | A Descriptor which is supplementary to, but not contained within, a Title | String | O | Live Version |
7 | ResourceDisplayArtistName | The Name to be used by a DSP when presenting Artist details of the Resource to a Consumer | String | M | The Beatles |
8 | ResourceDisplayArtistPartyId | The PartyId of the DisplayArtist | PartyId | O | ISNI::0000000081266409 |
9 | Duration
| 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 duration | C | PT1H2M3S |
10 | ResourceType | The Type of the Resource | AVS | M | SoundRecording |
11 (updated) | ProprietaryWorkId | The ProprietaryIdentifier of the Musical Work, preceded by a namespace identifier in the syntax ns::id | Multiple String::String | O | myns::4534 |
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 | ComposerAuthorName | The Name of a Writer of the Musical Work used in creating the Resource. ComposerAuthorName 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 ComposerAuthorName and ComposerAuthorPartyId shall be the same so that the recipient is able to relate names and IDs correctly | Multiple Strings | C | Johann Sebastian Bach |
14 | ComposerAuthorPartyId | The PartyId(s) of the ComposerAuthor(s) The order of the individual strings in ComposerAuthorName and ComposerAuthorPartyId shall be the same so that the recipient is able to relate names and IDs correctly | Multiple PartyIds | O | ISNI::0000000081266409 |
15 | ArrangerName | The Name of an Arranger of the Musical Work used in creating the Resource. ArrangerName 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 ArrangerName and ArrangerPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple Strings | C | August Wilhelmj |
16 | ArrangerPartyId | The PartyId(s) of the Arranger(s) The order of the individual strings in ArrangerName and ArrangerId shall be the same so that the recipient is able to relate names and IDs correctly | Multiple PartyIds | O | ISNI::0000000081266409 |
17 | MusicPublisherName | The Name of the MusicPublisher(s) of the Musical Work for the relevant Territory. MusicPublisherName 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 MusicPublisherName and MusicPublisherPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple Strings | C | UMP |
18 | MusicPublisherPartyId | The PartyID(s) of the MusicPublisher(s). The order of the individual strings in MusicPublisherName and MusicPublisherPartyId shall be the same so that the recipient is able to relate names and IDs correctly | Multiple PartyIds | O | ISNI::00000000111111111 |
19 | WorkContributorName | 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. WorkContributorName 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 WorkContributorName and WorkContributorPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple Strings | C | George Martin |
20 | WorkContributorPartyId | The PartyId(s) of the WorkContributor(s) The order of the individual strings in WorkContributorName and WorkContributorPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple PartyIds | O | ISNI::00000000111111111 |
21 | DspReleaseId | The ProprietaryIdentifier of the Release assigned by the MessageSender A DspReleaseId shall be provided if the sales transaction was in respect of a Release for which the message sender has information. | String | C | 1234567 |
22 | ProprietaryReleaseId | The ProprietaryIdentifier of the Release preceded by a namespace identifier in the syntax ns::id | Multiple String::String | O | myns::4534|ns2::4345 |
23 | ReleaseCatalogNumber | The catalogue number of the Release assigned by the issuing record company | String | O | 123456 |
24 | 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. | String | O | 12345678904321 |
25 | ReleaseDisplayArtistName | The Name to be used by a DSP when presenting Artist details of the Release to a Consumer | String | M | The Beatles |
26 | ReleaseDisplayArtistPartyId | The PartyId of the DisplayArtist | PartyId | O | ISNI::0000000081266409 |
27 | ReleaseTitle | The ReferenceTitle of the Release | String | M | Beatles for Sale |
28 | ReleaseSubTitle | A Descriptor which is supplementary to, but not contained within, a Title | String | O | Live Version |
29 | ReleaseType | The form in which a ReleaseCreator anticipates offering the Release to Consumers. | AVS | O | Album |
30 | ReleaseLabelName | The Name of the Label for the Release. | String | O | Apple Records |
31 | PLine | The PLine for the Release | String | O | ℗1970 Apple Records |
32 | ReleaseDataProviderName | The Name of the company that provided the Release information to the MessageSender If the Licensee generated the data provided in this record, the DataProviderName shall contain the DPID of the Licensee. | String | O | UMG |
33 | NumberOfTransactedResources | The number of the Resources that were transacted together with the Resource described in this SR01 Record. If, for example, a 10-track Release is being transacted, NumberOfTransactedResources shall be set to 10. If a Resource is transacted on its own (i.e. not in the context of a Release), NumberOfTransactedResources shall be set to 1. | Integer | M | 12 |
34 | 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. If a Release containing, for example, 10 sound recordings is transacted, a sales/usage report in accordance with a Single-Record Block Variant is likely to contain up to 10 SR01 Records with the same SalesTransactionId. | String | M | 34456 |
35 | 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 |
36 | SalesUpgrade | A Flag indicating whether the SalesTransaction applies to an upgraded Release (=true) or not (=false). | Boolean | M | false |
37 | Downloads | The number of Downloads of the Release or Resource provided to Consumers, including any sales adjustments. Sales adjustments include e.g. file failures. In the MRBV, downloads are reported in the Cell called Usages. | Integer | M | 100 |
38 | 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 | 20 |
39 | PriceConsumerPaid | 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 | 0.34 |
40 | CalculatedPriceConsumer PaidForResourceExcSalesTax | The calculated price the Consumer paid for the Resource being reported in this Record. If the transacted entity was a Release, the sum of all contained Resources' would equal the PriceConsumerPaidExcSalesTax. Whether CalculatedPriceConsumer PaidForResourceExcSalesTax is required depends on bilateral agreements between Licensor and Licensee. Note: this Cell is not part of the current version of the relevant Multi-Record Block Variant. DDEX expects the relevant Multi-Record Block Variant to be extended by this Cell at some stage. | Decimal | C | 0.64 |
41 | PromotionalActivity | Free-text Description of a promotional activity that led to the Release being distributed. | String | O |
|
42 (new) | ReleaseDate | The date when the Release was first made available, whether for physical or electronic/online distribution. | ISO Date | O | 1969-08-26 |
43 (new) | 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 must be provided when there is no UseType on the relevant Summary Record. It may not be provided when there is a UseType on the relevant Summary Record. | AVS | C | PermanentDowload |
Cell Name | Field Definition | Data Type | M/O/C | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “SR02.01” | Fixed String | M | SR02.01 |
2 | SummaryRecordId | The Identifier (specific to the Message) of the Summary Record that this Usage, Revenue or Sales Record provides details for. | String | M | 22 |
3 | DspResourceId | The ProprietaryIdentifier of the Resource assigned by the MessageSender | String | M | 12345678 |
4 | 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 |
5 | ResourceTitle | The ReferenceTitle of the Resource | String | M | Eight Days a Week |
6 | ResourceSubTitle | A Descriptor which is supplementary to, but not contained within, a Title | String | O | Live Version |
7 | ResourceDisplayArtistName | The Name to be used by a DSP when presenting Artist details of the Resource to a Consumer | String | M | The Beatles |
8 | ResourceDisplayArtistPartyId | The PartyId of the DisplayArtist | PartyId | O | ISNI::0000000081266409 |
9 | Duration | 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 duration | C | PT1H2M3S |
10 | ResourceType | The Type of the Resource | AVS | M | SoundRecording |
11 | ProprietaryWorkId | The ProprietaryIdentifier of the Musical Work, preceded by a namespace identifier in the syntax ns::id | String::String | O | myns::4534 |
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 | ComposerAuthorName | The Name of a Writer of the Musical Work used in creating the Resource. ComposerAuthorName 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 ComposerAuthorName and ComposerAuthorPartyId shall be the same order so that the recipient is able to relate names to IDs correctly. | Multiple Strings | C | Johann Sebastian Bach |
14 | ComposerAuthorPartyId | The PartyId(s) of the ComposerAuthor(s) The order of the individual strings in ComposerAuthorName and ComposerAuthorPartyId shall be the same order so that the recipient is able to relate names to IDs correctly. | Multiple PartyIds | O | ISNI::0000000081266409 |
15 | ArrangerName | The Name of an Arranger of the Musical Work used in creating the Resource. ArrangerName 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 ArrangerName and ArrangerPartyId shall be the same order so that the recipient is able to relate names to IDs correctly. | Multiple Strings | C | August Wilhelmj |
16 | ArrangerPartyId | The PartyId(s) of the Arranger(s) The order of the individual strings in ArrangerName and ArrangerPartyId shall be the same order so that the recipient is able to relate names to IDs correctly. | Multiple PartyIds | O | ISNI::0000000081266409 |
17 | MusicPublisherName | The Name of the MusicPublisher(s) of the Musical Work for the relevant Territory. MusicPublisherName 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 MusicPublisherName and MusicPublisherPartyId shall be the same order so that the recipient is able to relate names to IDs correctly. | Multiple Strings | C | UMP |
18 | MusicPublisherPartyId | The PartyID(s) of the MusicPublisher(s). The order of the individual strings in MusicPublisherName and MusicPublisherPartyId shall be the same order so that the recipient is able to relate names to IDs correctly. | Multiple PartyIds | O | ISNI::00000000111111111 |
19 | WorkContributorName | 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. WorkContributorName 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 WorkContributorName and WorkContributorPartyId shall be the same order so that the recipient is able to relate names to IDs correctly. | Multiple Strings | C | George Martin |
20 | WorkContributorPartyId | The PartyId(s) of the WorkContributor(s) The order of the individual strings in WorkContributorName and WorkContributorPartyId shall be the same order so that the recipient is able to relate names to IDs correctly. | Multiple PartyIds | O | ISNI::00000000111111111 |
21 | DspReleaseId | The ProprietaryIdentifier of the Release assigned by the MessageSender. A DspReleaseId shall be provided if the sales transaction was in respect of a Release for which the message sender has information. | String | C | 1234567 |
22 | ProprietaryReleaseId | The ProprietaryIdentifier of the Release preceded by a namespace identifier in the syntax ns::id | Multiple String::String | O | myns::4534|ns2::4345 |
23 | ReleaseCatalogNumber | The catalogue number of the Release assigned by the issuing record company | String | O | 123456 |
24 | 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. | String | O | 12345678904321 |
25 | ReleaseDisplayArtistName | The Name to be used by a DSP when presenting Artist details of the Release to a Consumer | String | M | The Beatles |
26 | ReleaseDisplayArtistPartyId | The PartyId of the DisplayArtist | PartyId | O | ISNI::0000000081266409 |
27 | ReleaseTitle | The ReferenceTitle of the Release | String | M | Beatles for Sale |
28 | ReleaseSubTitle | A Descriptor which is supplementary to, but not contained within, a Title | String | O | Live Version |
29 | ReleaseType | The form in which a ReleaseCreator anticipates offering the Release to Consumers. | AVS | O | Album |
30 | ReleaseLabelName | The Name of the Label for the Release. | String | O | Apple Records |
31 | PLine | The PLine for the Release | String | O | ℗1970 Apple Records |
32 | ReleaseDataProviderName | The Name of the company that provided the Release information to the MessageSender. If the Licensee generated the data provided in this record, the ReleaseDataProviderName shall contain the DPID of the Licensee. | String | O | UMG |
33 | 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 |
34 | 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 |
35 | NumberOfStreams | The number of Streams of the Release from the MessageSender to Consumers. | Decimal | M | 765.65 |
36 | PromotionalActivity | Free-text Description of a promotional activity that led to the Release being distributed. | String | O | Valentines Day Special |
37 (new) | ReleaseDate | The date when the Release was first made available, whether for physical or electronic/online distribution. | ISO Date | O | 1969-08-26 |
38 (new) | 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 must be provided when there is no UseType on the relevant Summary Record. It may not be provided when there is a UseType on the relevant Summary Record. | AVS | C | PermanentDowload |
39 (new) | PriceConsumerPaid | 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 | 0.99 |
Cell Name | Field Definition | Data Type | M/O/C | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “SR03.01” | Fixed String | M | SR03.01 |
2 | SummaryRecordId | The Identifier (specific to the Message) of the Summary Record that this Usage, Revenue or Sales Record provides details for. | String | M | 22 |
3 | DspResourceId | The ProprietaryIdentifier of the Resource assigned by the MessageSender | String | M | 12345678 |
4 | 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 |
5 | ResourceTitle | The ReferenceTitle of the Resource
| String | M | Yellow Submarine |
6 | ResourceSubTitle | A Descriptor which is supplementary to, but not contained within, a Title. | String | O | Live Version |
7 | ResourceDisplayArtistName | The Name to be used by a DSP when presenting Artist details of the Resource to a Consumer ResourceDisplayArtistName must be provided if available. | String | C | The Beatles |
8 | ResourceDisplayArtistPartyId | The PartyId of the DisplayArtist | PartyId | O | ISNI::0000000081266409 |
9 | Duration | 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 Duration | C | PT1H2M3S |
10 | ResourceType | The Type of the Resource | AVS | M | SoundRecording |
11 | MusicalWorkTitle | The ReferenceTitle of the MusicalWork | String | M | Yellow Submarine |
12 | DspWorkId | The ProprietaryIdentifier of the Musical Work assigned by the MessageSender | String | M | 12345678 |
13 | 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 |
14 | ComposerAuthorName | The Name of a Writer of the Musical Work used in creating the Resource. ComposerAuthorName 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 ComposerAuthorName and ComposerAuthorPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple Strings | C | Johann Sebastian Bach |
15 | ComposerAuthorPartyId | The PartyId(s) of the ComposerAuthor(s) The order of the individual strings in ComposerAuthorName and ComposerAuthorPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple PartyIds | O | ISNI::0000000081266409 |
16 | ArrangerName | The Name of an Arranger of the Musical Work used in creating the Resource. ArrangerName 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 ArrangerName and ArrangerPartyID shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple String | C | August Wilhelmj |
17 | ArrangerPartyId | The PartyId(s) of the Arranger(s) The order of the individual strings in ArrangerName 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) | O | ISNI::0000000081266409 |
18 | MusicPublisherName | The Name of the MusicPublisher(s) of the Musical Work for the relevant Territory. MusicPublisherName 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 MusicPublisherName and MusicPublisherPartyID shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple String | C | UMP |
19 | MusicPublisherPartyId | The PartyID(s) of the MusicPublisher(s). The order of the individual strings in MusicPublisherName 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 PartyID | O | ISNI::00000000111111111 |
20 | WorkContributorName | 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. WorkContributorName 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 WorkContributorName and WorkContributorPartyID shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple String | C | UMP |
21 | WorkContributorPartyId | The PartyId(s) of the WorkContributor(s) The order of the individual strings in WorkContributorName 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) | O | ISNI::000000008126640 |
22 | DspReleaseId | The ProprietaryIdentifier of the Release assigned by the MessageSender A DspReleaseId shall be provided is the sales transaction was in respect of a Release for which the message sender has information. | String | C | 1234567 |
23 | ProprietaryReleaseId | The ProprietaryIdentifier of the Release preceded by a namespace identifier in the syntax ns::id | Multiple String::String | O | myns::4534|ns2::4345 |
24 | ReleaseCatalogNumber | The catalogue number of the Release assigned by the issuing record company | String | O | 123456 |
25 | 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 |
26 | ReleaseDisplayArtistName | The Name to be used by a DSP when presenting Artist details of the Release to a Consumer. ReleaseDisplayArtistName shall be provided if available to the Message Sender. | String | C | The Beatles |
27 | ReleaseDisplayArtistPartyId | The PartyId of the DisplayArtist | PartyId | O | ISNI::0000000081266409 |
28 | ReleaseTitle | The ReferenceTitle of the Release | String | M | Beatles for Sale |
29 | ReleaseSubTitle | A Descriptor which is supplementary to, but not contained within, a Title | String | O | Live Version |
30 | ReleaseLabelName | The Name of the Label for the Release. | String | O | Apple Records |
31 | PLine | The PLine for the Release | String | O | ℗1970 Apple Records |
32 | 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 |
33 | Usages | The number of Usages of the Release by Consumers using the MessageSender service, including any sales adjustments. Sales adjustments include e.g. file failures. This includes all usages of the embedded Resources and is reported before taking any RightShare% or RightsType into account. | Decimal | M | 100.1 |
34 | 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 is reported before taking any RightShare% or RightsType into account. Must be provided in accordance with bilateral agreement. | Decimal | C | 10545.12 |
35 | ValidityPeriodStart | The first date at which, to the knowledge of the MessageSender, the information provided in the RighsController and RightShare% Cells is accurate. Note: the ValidityPeriodStart may be earlier (or later) than the first day covered by the sales/usage report. This allows, for example, to report changes of a Rights Controller in the middle of a sales/usage period. | ISO Date | M | 2017-06-01 |
36 | ValidityPeriodEnd | The last date at which, to the knowledge of the MessageSender, the information provided in the RighsController and RightShare% Cells is accurate. Note: the ValidityPeriodEnd may be later (or earlier) than the latest day covered by the sales/usage report. This allows, for example, to report changes of a Rights Controller in the middle of a sales/usage period. | ISO Date | M | 2017-06-01 |
37 | ContentCategory | A string categorising the content that has been used or distributed as agreed between sender and recipient. | String | M | Music |
38 | RightsControllerName | Name of the RightsController that is believed by the MessageSender to control a RightShare of the Work. If a SR 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. RightsControllerName shall be provided if available and required based on the bilateral agreement between sender and recipient. | String | C | SACEM |
39 | RightsControllerPartyId | The PartyId of the RightsController. RightsControllerPartyId shall be provided if available and required based on the bilateral agreement between sender and recipient. | PartyID | C | ISNI::0000000081266409 |
40 | RightsControllerWorkId | The ProprietaryId given to the MusicalWork used by the RightsContoller | String | O | 12gc |
41 | 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 “0.25” (and not 25). Must be provided in accordance with bilateral agreement. | Decimal | C | 33.33 |
42 | RightsType | The right for which the RightShare% is provided. If information for multiple RightsType needs to be communicated, multiple SR03 Records, one for each RightsType, need to be used. | AVS | O | MechanicalRight |
43 | AllocatedNetRevenue | Net Revenue generated that is to be allocated to the MessageRecipient/RightsController. Must be provided in accordance with bilateral agreement. | Decimal | C | 34567 |
44 | AllocatedAmount | The amount due to the RighsController for the Uses, Revenue or Sales as reported in this Block. Must be provided in accordance with bilateral agreement. | Decimal | C | 2560.77 |
45 | AllocatedUsages | The number of Usages allocated to the RightsController. | Decimal | C | 10.5 |
46 (updated) | Deprecated Cell (AllocatedNetUsage) | This Cell is not to be used. |
Cell Name | Field Definition | Data Type | M/O/C | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “SR04.01” | Fixed String | M | SR04.01 |
2 | SummaryRecordId | The Identifier (specific to the Message) of the Summary Record that this Usage, Revenue or Sales Record provides details for. Note: this Cell appears out of order but Summary RecordId are always the second Cell in a Record. | String | M | 22 |
3 | DspResourceId | The ProprietaryIdentifier of the Resource assigned by the MessageSender | String | M | 12345678 |
4 | 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 |
5 | 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 |
6 | ProprietaryResourceId | The ProprietaryIdentifier of the Resource preceded by a namespace identifier in the syntax ns::id | Multiple String::String | O | Myns::4534|ns2::4896 |
7 | VideoType | The primary Type of the Video. As only one value can be selected, the primary VideoType needs to be provided. | AVS | M | VideoReport |
8 | ResourceTitle | The Title of the Resource | String | M | Winter is Coming |
9 | ResourceSubTitle | A Descriptor which is supplementary to, but not contained within, a Title | String | O | Live Version |
10 | ResourceOriginalTitle | A Title given to a Creation by its Creator(s), in its original Language. ResourceOriginalTitle 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 | O | The Hamburger Postulate |
11 | EpisodeNumber | The number indicating the order of the Episodes within a Season (if available) or Series. This is the number allocated to the Episode by the production house. EpisodeNumber has to be provided for TV series episodes. | String | C | S1E5 |
12 | SeasonNumber | The number indicating the order of the Season within a Series. This is the number allocated to the Season by the production house. SeasonNumber has to be provided for seasons of TV series or parts thereof. | Stribng | C | S4 |
13 | Genre | The genre or style (such as Musical, literary or audio-visual) with which the Resource is associated. | String | O | Horror Comedy |
14 | Duration | The Duration of the 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 |
15 | ResourceDisplayArtistName | The Name to be used by a DSP when presenting Artist details of the Resource to a Consumer. To be provided for concert films or when the information is available. | String | C | The Beatles |
16 | ResourceDisplayArtistPartyId | The PartyId of the DisplayArtist. To be provided for concert films or when the information is available. | PartyId | C | ISNI::0000000081266409 |
17 | 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 |
18 | 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 |
19 | 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 |
20 | 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 |
21 | 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 |
22 | 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 |
23 | ProductionCompanyName | Name of the company that produced the Resource. | String | O | Production123 |
24 | ProductionCompanyPartyId | The PartyId of the ProductionCompany. Note: this Cell is not part of the current version of the relevant Multi-Record Block Variant. | Multiple PartyID | O | ISNI::0000000081266409 |
25 | LanguageLocalizationType | Type of adaptation of an Audio-visual Resource for a specific audience and/or language. LanguageLocalizationType needs to be provided if available to the message sender.
| AVS | C | Dubbed |
26 | HasCaptioning | 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 |
27 | 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 |
28 | OriginalLanguageOfPerformance | The main original Language of the Performance recorded in the audio-visual Resource. The first language code must be main language.
| Multiple ISO Language Code | O | en |
29 | LanguageOfDubbing | The Language of dubbing used in the audio-visual Resource. The first language code must be the main language. LanguageOfDubbing is mandatory when LanguageLocalizationType is Dubbed, SubTitled or Multilingual. | Multiple ISO Language Code | O | de |
30 | DateOfProductionOrRelease | 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 |
31 | 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 |
32 | OriginalBroadcastChannel | The broadcast channel on which the Release was originally broadcast in the territory that is being reported on. OriginalBroadcastChannel is mandatory for services deemed to be “catch-up” television. | String | C | BBC One |
33 | OriginalBroadcastDateTime | The date and, if available, time, of the original broadcast of the Resource in ISO 8601 format in the territory that is being reported on. OrigialBroadcastDateTime is mandatory for services deemed to be “catch-up” television. | ISO 8601 | C | 1999-10-27T20:00:00Z |
34 | DspReleaseId | The ProprietaryIdentifier of the Release assigned by the MessageSender. To be provided when the sales/usage information is provided for a resource that has been distributed in the context of a Release. | String | C | 12345678 |
35 | ProprietaryReleaseId | The ProprietaryIdentifier of the Release preceded by a namespace identifier in the syntax ns::id | Multiple String::String | O | Myns::4534|ns2::4896 |
36 | 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 |
37 | ReleaseTitle | The ReferenceTitle of the Release. To be provided when the sales/usage information is provided for a resource that has been distributed in the context of a Release. | String | C | The Hamburger Postulate |
38 | ReleaseSubTile | A Descriptor which is supplementary to, but not contained within, a Title. | String | O |
|
39 | 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 |
40 | ReleaseType | The form in which a ReleaseCreator anticipates offering the Release to Consumers. | AVS | O | LongFormNonMusical-WorkVideoRelease |
41 | DataProviderName | The Name of the company that provided the information to the MessageSender. If the Licensee generated the data provided in this record, the DataProviderName shall contain the DPID of the Licensee. | String | O | UMG |
42 | VideoCategory | A description of the content of the video as agreed between sender and recipient to classify the used Release. | String | O | Sport |
43 | 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 |
44 | IsDrmEnforced | The Flag indicating if the Release was technically protected or not. IsDrmEnforced 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”. | Boolean | C | false |
45 | VideoDefinitionType | The type of resolution (or definition) in which a Video is provided. VideoDefinitionType 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 |
46 | 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 |
47 | 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 |
48 | 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 |
49 | Downloads | The number of Downloads of the Release or Resource provided to Consumers, including any sales adjustments. Sales adjustments include e.g. file failures. | Decimal | M | 1000 |
50 | 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 |
51 | 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 |
52 | PromotionalActivity | Free-text Description of a promotional activity that led to the Release being distributed. | String | O | Valentines Day Special |
53 (new) | CueSheetDataProvider | The Name of the company that provided the Cue Sheet information to the MessageSender. | String | O | UMG |
54 (new) | 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 must be provided when there is no UseType on the relevant Summary Record. It may not be provided when there is a UseType on the relevant Summary Record. | AVS | C | PermanentDowload |
Cell Name | Field Definition | Data Type | M/O/C | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “SR05.01” | Fixed String | M | SR05.01 |
2 | SummaryRecordId | The Identifier (specific to the Message) of the Summary Record that this Usage, Revenue or Sales Record provides details for. Note: this Cell appears out of order but SummaryRecordId are always the second Cell in a Record. | String | M | 22 |
3 | DspResourceId | The ProprietaryIdentifier of the Resource assigned by the MessageSender | String | M | 12345678 |
4 | 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 |
5 | 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 |
6 | ProprietaryResourceId | The ProprietaryIdentifier of the Resource preceded by a namespace identifier in the syntax ns::id | Multiple String::String | O | Myns::4534|ns2::4896 |
7 | VideoType | The primary Type of the Video. As only one value can be selected, the primary VideoType needs to be provided. | AVS | M | VideoReport |
8 | ResourceTitle | The Title of the Resource | String | M | Beatles for Sale Winter is Coming |
9 | ResourceSubTitle | A Descriptor which is supplementary to, but not contained within, a Title | String | O | Live Version |
10 | ResourceOriginalTitle | A Title given to a Creation by its Creator(s), in its original Language. The ResourceOriginalTitle 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 | O | The Hamburger Postulate |
11 | EpisodeNumber | The number indicating the order of the Episodes within a Season (if available) or Series. This is the number allocated to the Episode by the production house. EpisodeNumber has to be provided for TV series episodes. | String | C | S1E5 |
12 | SeasonNumber | The number indicating the order of the Episodes within a Season (if available) or Series. This is the number allocated to the Season by the production house. SeasonNumber has to be provideds for easons of TV series or parts thereof. | Stribng | C | S4 |
13 | Genre | The genre or style (such as Musical, literary or audio-visual) with which the Resource is associated. | String | O | Horror Comedy |
14 | 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 |
15 | ResourceDisplayArtistName | The Name to be used by a DSP when presenting Artist details of the Resource to a Consumer. To be provided for concert films or when the information is available. | String | C | The Beatles |
16 | ResourceDisplayArtistPartyId | The PartyId of the DisplayArtist. To be provided for concert films or when the information is available. | PartyId | O | ISNI::0000000081266409 |
17 | 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 |
18 | 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 |
19 | 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 |
20 | 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 |
21 | 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 |
22 | 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 |
23 | ProductionCompanyName | Name of the company that produced the Resource. | String | O | Production123 |
24 | ProductionCompanyPartyId | The PartyId of the ProductionCompany. | Multiple PartyID | O | ISNI::0000000081266409 |
25 | LanguageLocalizationType | Type of adaptation of an Audio-visual Resource for a specific audience and/or language. LanguageLocalizationType shall be provided when available to the Message Sender. | AVS | C | Dubbed |
26 | HasCaptioning | 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 |
27 | 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 |
28 | OriginalLanguageOfPerformance | The main original Language of the Performance recorded in the audio-visual Resource. The first language code must be main language. | Multiple ISO Language Code | O | en |
29 | LanguageOfDubbing | The Language of dubbing used in the audio-visual Resource. The first language code must be main language. LanguageOfDubbing is mandatory when LanguageLocalizationType is Dubbed, SubTitled or Multilingual. | Multiple ISO Language Code | O | de |
30 | DateOfProductionOrRelease | 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 |
31 | 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 |
32 | OriginalBroadcastChannel | The broadcast channel on which the Release was originally broadcast in the territory that is being reported on. OriginalBroadcastChannel is mandatory for services deemed to be “catch-up” television or streaming. | String | C | BBC One |
33 | OriginalBroadcastDateTime | The date and, if available, time, of the original broadcast of the Resource in ISO 8601 format in the territory that is being reported on. OrigialBroadcastDateTime is mandatory for services deemed to be “catch-up” television or streaming. | ISO 8601 | C | 1999-10-27T20:00:00Z |
34 | DspReleaseId | The ProprietaryIdentifier of the Release assigned by the MessageSender. To be provided when the sales/usage information is provided for a resource that has been distributed in the context of a Release | String | C | 12345678 |
35 | ProprietaryReleaseId | The ProprietaryIdentifier of the Release preceded by a namespace identifier in the syntax ns::id | Multiple String::String | O | Myns::4534|ns2::4896 |
36 | 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 |
37 | ReleaseTitle | The ReferenceTitle of the Release. To be provided when the sales/usage information is provided for a resource that has been distributed in the context of a Release. | String | C | The Hamburger Postulate |
38 | ReleaseSubTile | A Descriptor which is supplementary to, but not contained within, a Title. | String | O |
|
39 | 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 |
40 | ReleaseType | The form in which a ReleaseCreator anticipates offering the Release to Consumers. | AVS | O | LongFormNonMusical-WorkVideoRelease |
41 | DataProviderName | The Name of the company that provided the information to the MessageSender. If the Licensee generated the data provided in this record, the DataProviderName shall contain the DPID of the Licensee. | String | O | UMG |
42 | VideoCategory | A description of the content of the video as agreed between sender and recipient to classify the used Release. | String | O | Sport |
43 | 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 |
44 | VideoDefinitionType | The type of resolution (or definition) in which a Video is provided. VideoDefinitionType 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 |
45 | 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 |
46 | 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 |
47 | 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 |
48 | NumberOfStreams | The number of Streams of the Release or Resource provided to Consumers, including any sales adjustments. Sales adjustments include e.g. file failures. | Decimal | M | 1000 |
49 | PromotionalActivity | Free-text Description of a promotional activity that led to the Release being distributed. | String | O | Valentines Day Special |
50 (new) | CueSheetDataProvider | The Name of the company that provided the Cue Sheet information to the MessageSender. | String | O | UMG |
51 (new) | 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 must be provided when there is no UseType on the relevant Summary Record. It may not be provided when there is a UseType on the relevant Summary Record. | AVS | C | PermanentDowload |
52 (new) | 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 | 0.99 |
Cell Name | Field Definition | Data Type | M/O/C | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “SR06.01” | Fixed String | M | SR06.01 |
2 | SummaryRecordId | The Identifier (specific to the Message) of the Summary Record that this Usage, Revenue or Sales Record provides details for. | String | M | 22 |
3 | DspResourceId | The ProprietaryIdentifier of the Resource assigned by the MessageSender | String | M | 12345678 |
4 | 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 |
5 | ResourceTitle | The ReferenceTitle of the Resource
| String | M | Yellow Submarine |
6 | ResourceSubTitle | A Descriptor which is supplementary to, but not contained within, a Title. | String | O | Live Version |
7 | ResourceDisplayArtistName | The Name to be used by a DSP when presenting Artist details of the Resource to a Consumer. ResourceDisplayArtistName should be provided if available to the Message Sender. | String | C | The Beatles |
8 | ResourceDisplayArtistPartyId | The PartyId of the DisplayArtist | PartyId | O | ISNI::0000000081266409 |
9 | MusicalWorkTitle | The ReferenceTitle of the MusicalWork | String | M | Yellow Submarine |
10 | DspWorkId | The ProprietaryIdentifier of the Musical Work assigned by the MessageSender | String | M | 12345678 |
11 | 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 |
12 | ComposerAuthorName | The Name of a Writer of the Musical Work used in creating the Resource. ComposerAuthorName 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 ComposerAuthorName and ComposerAuthorPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple Strings | C | Johann Sebastian Bach |
13 | ComposerAuthorPartyId | The PartyId(s) of the ComposerAuthor(s) The order of the individual strings in ComposerAuthorName and ComposerAuthorPartyId shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple PartyIds | O | ISNI::0000000081266409 |
14 | Usages | The number of Usages of the Release by Consumers using the MessageSender service, including any sales adjustments. Sales adjustments include e.g. file failures. This includes all usages of the embedded Resources and is reported before taking any RightShare% or RightsType into account. | Decimal | M | 100.1 |
15 | ValidityPeriodStart | The first date at which, to the knowledge of the MessageSender, the information provided in the RighsController and RightShare% Cells is accurate. Note: the ValidityPeriodStart may be earlier (or later) than the first day covered by the sales/usage report. | ISO Date | M | 2017-06-01 |
16 | ValidityPeriodEnd | The last date at which, to the knowledge of the MessageSender, the information provided in the RighsController and RightShare% Cells is accurate. Note: the ValidityPeriodEnd may be later (or earlier) than the latest day covered by the sales/usage report. | ISO Date | M | 2017-06-01 |
17 | ContentCategory | A string categorising the content that has been used or distributed as agreed between sender and recipient. | String | M | Music |
18 | RightsControllerName | Name of the RightsController that is believed by the MessageSender to control a RightShare of the Work. If a SR 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. RightsControllerName shall be provided if available and required based on the bilateral agreement between sender and recipient. | String | C | SACEM |
19 | RightsControllerPartyId | The PartyId of the RightsController. RightsControllerPartyId shall be provided if available and required based on the bilateral agreement between sender and recipient. | PartyID | C | ISNI::0000000081266409 |
20 | RightsControllerWorkId | The ProprietaryId given to the MusicalWork used by the RightsContoller | String | O | 12gc |
21 | 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 “0.25” (and not 25). RightShare% shall be provided if available and required based on the bilateral agreement between sender and recipient. | Decimal | C | 33.33 |
22 | RightsType | The right for which the RightShare% is provided. RightsType shall be provided if available and required based on the bilateral agreement between sender and recipient. | AVS | C | MechanicalRight |
23 | AllocatedAmount | The amount due to the RighsController for the Uses, Revenue or Sales as reported in this Block. Must be provided in accordance with bilateral agreement. | Decimal | C | 2560.77 |
24 | AllocatedNetUsage | The number of net Usages allocated to the RightsController. | Decimal | C | 8.4 |
25 (added) | AllocatedNetRevenue | Net Revenue generated that is to be allocated to the MessageRecipient/RightsController in the CurrencyOfTransaction. AllocatedNetRevenue shall be provided based on the contractual relationship between Licensee and Licensor. | Decimal | C | 34567 |
Cell Name | Field Definition | Data Type | M/O/C? | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record; always to contain “SR07.01”. | Fixed string | M | SR07.01 |
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 Masterlist message provides details for. | String | M | 34 |
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 | ReleaseCatalogNumber | 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 Message Senders genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”. | String | C | 12345678904321 |
8 | ReleaseDisplayArtistName | The Name to be used by a DSP when presenting Artist details of the Release to a Consumer | String | M | The Beatles |
9 | ReleaseDisplayArtistPartyId | The PartyId of the DisplayArtist | PartyID | O | ISNI::0000000081266409 |
10 | ReleaseTitle | The ReferenceTitle of the Release | String | M | Beatles for Sale |
11 | ReleaseSubTitle | 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 | ReleaseLabelName | The Name of the Label for the Release. | String | O | Apple Records |
14 | ReleasePLine | The PLine for the Release | String | O | ℗1970 Apple Records |
15 | DspResourceId | The ProprietaryIdentifier of the Resource assigned by the DSP. | String | M | 12345678 |
16 (updated) | 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 |
17 | ResourceTitle | The ReferenceTitle of the SoundRecording. | String | M | Bohemian Rhapsody |
18 | ResourceSubTitle | A Descriptor which is supplementary to, but not contained within, a Title. | String | O | Live Version |
19 | ResourceDisplayArtistName | The Name to be used by a DSP when presenting Artist details of the Resource to a Consumer. | String | M | Queen |
20 | ResourceDisplayArtistPartyId | The PartyId of the DisplayArtist | PartyID | O | ISNI::0000000081266409 |
21 | ResourceDuration | 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 MessageSender. | ISO duration | C | PT1H2M3S |
22 | ResourceType | The Type of the Resource | AVS | M | SoundRecording |
23 | DspWorkId | The ProprietaryIdentifier of the Musical Work assigned by the DSP. | String | M | 12345678 |
24 | 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 Message Senders genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”. | String | C | T0030749586 |
25 | MusicalWorkTitle | The ReferenceTitle of the Musical Work | String | M | Bohemian Rhapsody |
26 | MusicalWorkSubTitle | A Descriptor which is supplementary to, but not contained within, a Title. | String | O | Live version |
27 | ComposerAuthorName | The Name of a Writer of the Musical Work used in creating theResource. ComposerAuthorName 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 Message Sendersgenuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”. The order of the individual strings in ComposerAuthorName and ComposerAuthorPartyID shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple String | C | Johann Sebastian Bach |
28 | ComposerAuthorPartyId | The PartyId(s) of the ComposerAuthor(s) The order of the individual strings in ComposerAuthorName 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) | O | ISNI::0000000081266409 |
29 | ArrangerName | The Name of an Arranger of the Musical Work used in creating the Resource. ArrangerName 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 Message Senders genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”. The order of the individual strings in ArrangerName and ArrangerPartyID shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple String | C | August Wilhelmj |
30 | ArrangerPartyId | The PartyId(s) of the Arranger(s) The order of the individual strings in ArrangerName 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) | O | ISNI::0000000081266409 |
31 | MusicPublisherName | The Name of the MusicPublisher(s) of the Musical Work for the relevant Territory. MusicPublisherName 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 Message Sendersgenuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”. The order of the individual strings in MusicPublisherName and MusicPublisherPartyID shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple String | C | UMP |
32 | MusicPublisherPartyId | The PartyID(s) of the MusicPublisher(s). The order of the individual strings in MusicPublisherName 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 PartyID | O | ISNI::00000000111111111 |
33 | WorkContributorName | The Name of a contributor of the Musical 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. WorkContributorName 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 Message Senders genuinely do not have this information, DDEX has decided to mark these Cells as “Conditional”. The order of the individual strings in WorkContributorName and WorkContributorPartyID shall be the same so that the recipient is able to relate names and IDs correctly. | Multiple String | C | UMP |
34 | WorkContributorPartyId | The PartyId(s) of the WorkContributor(s) The order of the individual strings in WorkContributorName 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) | O | ISNI::0000000081266409 |
35 | DataProviderName | The Name of the company that provided the MusicalWork information to the MessageSender | String | O | UMG |
36 | ProprietaryWorkId | The ProprietaryIdentifier of the Musical Work, preceded by a namespace identifier in the syntax ns::id | Multiple String::String | O | myns::4534 |
37 | UsageForPrioritisation | The number of Usages of the Resource or Musical Work that is either expected by the Licensee based on previous sales/reporting periods' usages or that have already occurred. UsageForPrioritisation have to be provided if such information is available, based on bilateral agreements. This information is intended to aid the Message Recipient to prioritise handling the information provided in the report. | Integer | C | 400 |
38 | PercentileForPrioritisation | The percentile of usage in which the Licensee either expects this Resource to appear, based on an estimation of its use compared to the sum of all the views for all the "active" Resources in the the Sales Context provided via the referenced Summary Record, or based on usages that have already occurred, It is an integer value that ranges from 0 to 100. PercentileForPrioritisation has to be provided if such information is available based on bilateral agreements. | Integer | C | 5 |
39 | UnclaimedPercentage | The RightShare percentage of the Musical Work not claimed at the time listed in the MessageCreatedDateTime in the Message Header as assumed by the Message Sender. | Decimal | O | 33.33 |
40 (new) | NumberOfTransactedResources | The number of the Resources that were transacted. | Integer | M | 12 |
41 (new) | ReleaseDate | The date when the Release was first made available, whether for physical or electronic/online distribution. | ISO Date | O | 1969-08-26 |
If sales/usages for a Release are to be reported:
Cells 2–12 must be reported (subject to further rules below) and Cells 13–24 must be omitted;
The following identifiers shall be communicated if available to the Message Sender:
All Release IDs received by the Message Sender (e.g. in a NewReleaseMessage as defined in the the Electronic Release Notification Message Suite Standard);
The DSP’s proprietary ID for the Release;
GRID or ICPM for the Release; and
A ContextReleaseGRid, if the Release is equivalent to a TrackRelease as defined in the the Electronic Release Notification Message Suite Standard.
If sales/usages for a Resource are to be reported:
Cells 13–24 must be reported (subject to further rules below). Cells 2–12 must also be reported if available to the message sender. Cells 2–12 may only be omitted, if the sender does not have access to the information;
The following identifiers shall be communicated if available to the Message Sender:
All Resource IDs received by the Message Sender (e.g. in a NewReleaseMessage as defined in the the Electronic Release Notification Message Suite Standard);
The DSP’s proprietary ID for the Resource;
ResoucerIsrc for the Resource; and
A ContextReleaseGRid (if available).
Cell Name | Field Definition | Data Type | M/O/C | Example | |
---|---|---|---|---|---|
1 | RecordType | The Type of the Record, always to contain “SR08.01” | Fixed String | M | SR08.01 |
2 | 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 | A13HG65 |
Release Information | |||||
3 | GRid | The GRid identifying the Release. This is the preferred Element and is mandatory if a GRid is available. A GRid comprises four parts: the xs:string 'A1', followed by five alphanumeric characters, ten alphanumeric characters and one alphanumeric character. DDEX will enforce the syntax [a-zA-Z0-9]{18} using XML Schema in the future. | String | C | A1AAAAA1234567890X |
4 | 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. | String | C | 123456789012 |
5 | DspReleaseId | The ProprietaryIdentifier of the Release assigned by the MessageSender. | String | M | 12345678 |
6 | LabelReleaseId | The ProprietaryIdentifier of the Release assigned by the Record Company that provided the Release information to the MessageSender. | String | C | ABC |
7 | ProprietaryReleaseId | The ProprietaryIdentifier of the Release preceded by a namespace identifier in the syntax ns::id. | Multiple String::String | O | myns::4534|ns2::4345 |
8 | ContextReleaseGRid | The GRid identifying the Release from which the Release was taken. This is the preferred Element and is mandatory if a GRid is available. A GRid comprises four parts: the xs:string 'A1', followed by five alphanumeric characters, ten alphanumeric characters and and one alphanumeric character. DDEX will enforce the syntax [a-zA-Z0-9]{18} using XML Schema in the future. | String | O | A1AAAAA1234567890X |
9 | ReleaseType | The form in which a ReleaseCreator anticipates offering the Release to Consumers. | AVS | C | Album |
10 | ReleaseTitle | The ReferenceTitle of the Release. | String | C | Beatles for Sale |
11 | ReleaseSubTitle | A Descriptor which is supplementary to, but not contained within, a Title. | String | O | Live Version |
12 | ReleaseDisplayArtistName | The Name to be used by a DSP when presenting Artist details of the Release to a Consumer. | String | C | The Beatles |
13 | ReleaseDisplayArtistPartyId | The PartyId of the DisplayArtist. | PartyId | O | ISNI::0000000081266409 |
Resource Information | |||||
14 | ISRC | The ISRC (International Standard Recording Code as defined in ISO 3901) for the SoundRecording. An ISRC comprises four parts: two characters, followed by three alphanumeric characters, then two digits and five digits. | String | C | USS1Z1412345 |
15 | ISAN | The ISAN (International Standard Audio-visual Number as defined in ISO 15706) for the Video. An ISAN comprises four blocks of four hexadecimal characters followed by a check character followed, optionally, by two further blocks of four hexadecimal characters, followed by a further check character. | String | O | 1234-5678-0ABC-DEF0-A |
16 | DspResourceId | The ProprietaryIdentifier of the Resource assigned by the MessageSender. DspResourceId is mandatory if sales/usages for a Resource are to be reported. | String | C | 12345678 |
17 | LabelResourceId | The ProprietaryIdentifier of the Resource assigned by the Record Company (typically also the MessageRecipient). | String | C | 12345678 |
18 | ProprietaryResourceId | The ProprietaryIdentifier of the Resource preceded by a namespace identifier in the syntax ns::id. | Multiple String::String | O | myns::4534|ns2::4345 |
19 | ContextReleaseGRid
| The GRid identifying the Release from which the Resource was taken. This is the preferred Element and is mandatory if a GRid is available. A GRid comprises four parts: the xs:string 'A1', followed by five alphanumeric characters, ten alphanumeric characters and and one alphanumeric character. DDEX will enforce the syntax [a-zA-Z0-9]{18} using XML Schema in the future. | String | C | A1AAAAA1234567890X |
20 | ResourceType | The Type of the Resource. | AVS | C | SoundRecording |
21 | ResourceTitle | The ReferenceTitle of the Resource. | String | C | Roll over Beethoven |
22 | ResourceSubTitle | A Descriptor which is supplementary to, but not contained within, a Title. | String | O | Live Version |
23 | ResourceDisplayArtistName | The Name to be used by a DSP when presenting Artist details of the Resource to a Consumer. | String | C | The Beatles |
24 | ResourceDisplayArtistPartyId
| The PartyId of the DisplayArtist. | PartyId | O | ISNI::0000000081266409 |
Sales/Usage information | |||||
25 | SummaryRecordId
| The Identifier (specific to the Message) of the Summary Record that this Usage, Revenue or Sales Record provides details for. | String | M | 1224 |
26 | SalesTransactionDate | The date of the Sales Transaction. All data below is provided for this date. | ISO Date | M | 2017-06-01 |
28 | Usages | The number of Usages of the Release or Resource by Consumers that are using the MessageSender service, during the sub-period. | Decimal | M | 145.5 |
29 | Returns | The number of Usages of a Release or Resource returned to the MessageSender (which also involves a refund to the Consumer) as a result of a reversal of a SalesTransaction or because of an earlier error in sales reporting in sub-period. If no returns are to be reported the value should be 0. | Integer | M |
|
30 | NetUsage | The number of Usages less the number of Returns in the reporting sub-period . | Decimal | M | 126.2 |
31 | WholesalePrice
| The wholesale price of the Release or Resource in sub-period in the CurrencyOfTransaction. This information does not need to be provided in streaming models. | Decimal | C | 9.99 |
32 | WholesalePrice | The wholesale price of the Release or Resource in sub-period in the CurrencyOfAccounting. This information does not need to be provided in streaming models. | Decimal | C | 8.43 |
33 | SuggestedConsumerPrice | A Price agreed between DSP and MessageRecipient/RightsController for the Usage of the Release or Resource in sub-period in the CurrencyOfTransaction. This information does not need to be provided in streaming models. | Decimal | C | 15.0 |
34 | SuggestedConsumerPrice | A Price agreed between ReleaseDistributor and ReleaseCreator for the Usage of the Release in sub-period in the CurrencyOfAccounting. This information does not need to be provided in streaming models. | Float | C | 12.35 |
35 | PriceType | The Type of the price. This is often agreed in a rate card between DSP and MessageRecipient/RightsController . Either a PriceType or PriceRangeType (but not both) must be provided. | String | C | X55 |
36 | PriceRangeType | A PriceRange agreed between DSP and MessageRecipient/RightsController for the Usage of the Release or Resource in sub-period. Either a PriceType or PriceRangeType (but not both) must be provided. | String | C | Budget |
37 | PriceConsumerPaidExcSalesTax | A Price paid by Consumers, excluding SalesTax for each SalesTransaction in the CurrencyOfTransaction. This may be a nominal price in sub-period. This information does not need to be provided in streaming models. | Decimal | C | 1.22 |
38 | PriceConsumerPaidExcSalesTax | A Price paid by Consumers, excluding SalesTax for each SalesTransaction in the CurrencyOfAccounting. This may be a nominal price in sub-period. This information does not need to be provided in streaming models. | Decimal | C | 1.67 |
39 | DeductionType | Different types of deductions that the DSP applies before allocating revenue to the MessageRecipient/RightsController in the CurrencyOfAccounting. This information does not need to be provided in streaming models. The order of the individual data elements in DeductionType, DeductionsInCurrencyOfTransaction and DeductionsInCurrencyOfAccounting shall be the same order so that the recipient is able to relate them correctly. | Multiple String | C | AsPerContract |
40 | DeductionsIn | Deductions that the DSP applies before allocating revenue to the MessageRecipient/RightsController in the CurrencyOfAccounting in the CurrencyOfTransaction. One Deduction amount has to be provided for each DeductionType. This information does not need to be provided in streaming models. The order of the individual data elements in DeductionType, DeductionsInCurrencyOfTransaction and DeductionsInCurrencyOfAccounting shall be the same order so that the recipient is able to relate them correctly. | Multiple Decimals | C | 1452.24|12372.66 |
41 | DeductionsIn | Deductions that the DSP applies before allocating revenue to the MessageRecipient/RightsController in the CurrencyOfAccounting in the CurrencyOfAccounting. One Deduction amount has to be provided for each DeductionType. This information does not need to be provided in streaming models. The order of the individual data elements in DeductionType, DeductionsInCurrencyOfTransaction and DeductionsInCurrencyOfAccounting shall be the same order so that the recipient is able to relate them correctly. | Multiple Decimals | C | 1452.24|12372.66 |
42 (update) | RightSharePercentage
| Percentage applied to calculate AllocatedNetRevenue owed to the MessageRecipient/RightsController. This information is especially useful for DJ Mixes. RightSharePercentage is to be provided if (i) the percentage is not 100% and (ii) the information is available. | Decimal | C | 100 |
43 | CalculatedUnitPrice | The amount calculated as being allocated to a single transaction in the CurrencyOfTransaction. This may be based on the WholesalePriceInCurrencyOfTransaction, PriceConsumerPaid, PriceType, PriceRangeType or other bilaterally-agreed aspects. | Decimal | M | 543.54 |
44 | CalculatedUnitPrice | The amount calculated as being allocated to a single transaction in the CurrencyOfAccounting. This may be based on the WholesalePriceInCurrencyOfAccounting, PriceConsumerPaid, PriceType, PriceRangeType or other bilaterally-agreed aspects. | Decimal | M | 23.12 |
45 | AllocatedRevenue | The amount allocated to the MessageRecipient/RightsController for the Usages reported in the CurrencyOfTransaction. The AllocatedRevenueInCurrencyOfTransaction would typically be the product of CalculatedUnitPriceInCurrencyOfTransaction and AllocatedUsages. | Decimal | M | 1.67 |
46 | AllocatedRevenue | The amount allocated to the MessageRecipient/RightsController for the Usages reported in the CurrencyOfAccounting. The AllocatedRevenueInCurrencyOfAccounting would typically be the product of CalculatedUnitPriceInCurrencyOfAccounting and AllocatedUsages. | Decimal | M | 1.67 |
47 | AllocatedNetRevenue | Net Revenue generated by the DSP that is to be allocated to a Release or Resource in the CurrencyOfTransaction. | Decimal | M | 1.67 |
48 | AllocatedNetRevenue | Net Revenue generated by the DSP that is to be allocated to a Release or Resource in the CurrencyOfAccounting. | Decimal | M | 1.67 |
49 | CopyrightObligationWithDSP | The flag that indicates whether the obligation for reporting sale/usages to the owners or controllers of embedded MusicalWorks lies with the DSP (true) or not (false). | Boolean | M | true |
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:
- The suitability or fitness of the standards for any particular purpose;
- The merchantability of the standards;
- The accuracy, completeness, relevance or validity of the standards; or
- 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.