RecordType

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

Fixed string

M

HEAD

MessageVersion

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

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


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

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

Fixed string

M

dsrf/1.1.2/1.6/1.0

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

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

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

FileNumber

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

Integer

M

2

NumberOfFiles

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

Integer

M

3

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

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

SenderPartyId

The DDEX PartyId (DPID) of the MessageSender

DDEX Party ID

M

PADPIDA2008120501W

SenderName

The Full Name of the MessageSender

String

M

Apple

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

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

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

RepresentedRepertoire

Multiple strings

O

GEMA|PAECOL

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

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.

The DDEX Party ID of the DistributionChannel.

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

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

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

The Territory for which the Sale/Usage is reported.

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.

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.

The number of subscribers to a Service.

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

Decimal

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

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

Decimal

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

IndirectNetRevenue shall only be provided when indirect revenues were generated.

Decimal

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

Decimal

O

1.205648

RightsType

A Type of Right which is covered.

AVS

O

ContentCategory

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

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

Decimal

O

1.205648

RecordType

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

Fixed string

M

SY03

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.

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.

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

UseType

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

AVS

M

Territory

The Territory for which the Sale/Usage is reported.

AVS

M

FR

ServiceDescription

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

String

M

PremiumService

Usages

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

Integer

M

1234

Subscribers

The number of subscribers to a Service.

Decimal

M

1239867

Currency

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

AVS

M

CAD

NetRevenue

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

Decimal

M

10545.12

RightsController

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

String

O

SACEM

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

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

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

AllocatedNetRevenue

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

Decimal

O

781.73

RightsControllerMarketShare

The ratio in percent between Usages and AllocatedUsages.

Decimal

O

18.25

ConsumerPaidUnitPrice

The average price paid by the Subscribers

Decimal

M

6.62

Decimal

M

1239867

ExchangeRate

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

Decimal

O

1.205648

RecordType

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

Fixed string

M

SY04

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

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

DistributionChannelDPID

The DDEX Party ID of the DistributionChannel.

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

DPID

C

DPIDA12345SDF

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

UseType

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

AVS

M

Stream

Territory

The Territory for which the Sale/Usage is reported.

AVS

M

FR

ServiceDescription

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

String

M

PremiumService

SubscriberType

The type of Subscriber.

String

M

Student

Subscribers

The number of subscribers to a Service for each SubscriberType.

Decimal

M

1239867

SubPeriodStartDate

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

ReportingSubperiodStartDate shall only be provided when they differ from the UsageStartDate and UsageEndDate in the message header Record. ReportingSubperiodStartDate and ReportingSubperiodEndDate shall always be provided together.

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

Date

C

2014-12-01

SubPeriodEndDate

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

ReportingSubperiodEndDate shall only be provided when they differ from the UsageStartDate and UsageEndDate in the message header Record. ReportingSubperiodStartDate and ReportingSubperiodEndDate shall always be provided together.

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

Date

C

2014-12-01

UsagesInSubPeriod

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

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

Integer

C

1234

UsagesInReportingPeriod

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

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

Integer

C

1234

Currency

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

AVS

M

CAD

ExchangeRateBaseCurrency

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

AVS

O

USD

ExchangeRate

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

Decimal

O

1.205648

ConsumerPaidUnitPrice

The average price paid by the Subscribers

Decimal

M

6.62

NetRevenue

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

Decimal

M

10545.12

MusicUsagePercentage

The percentage of musical content in the subscription service.

Decimal between 0 and 100

M

14.54

RecordType

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

Fixed string

M

SY05

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

DistributionChannel

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

String

C

MyCo

DistributionChannelDPID

The DDEX Party ID of the DistributionChannel

DPID

C

DPIDA12345SDF

CommercialModel

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

AVS

M

SubscriptionModel

UseType

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

AVS

M

Stream

Territory

The Territory for which the sale/transaction is reported.

AVS

M

FR

RightsController

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

String

O

SACEM

RightsControllerPartyId

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

PartyId

O

ISNI::0000000081266409

RightsType

Type of Right for which the Revenue and Usages applies

AVS

M

PerformingRight

AllocatedUsages

The number of Usages allocated to the RightsController.

Multiple Decimal

O

411.29

AllocatedNetRevenue

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

Multiple Decimals

O

20.45

AllocatedRevenue

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

This is sometimes called Amount Payable.

Decimal

O

781.73

RightsControllerMarketShare

The ratio in percent between TotalUsages and AllocatedUsages

Decimal

O

18.25

Currency

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

AVS

O

EUR

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

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

Decimal

SubscriberType

The type of Subscriber.

String

O

Student

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

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

ContentCategory

ExchangRateBaseCurrency

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

AVS

O

EUR

RecordType

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

Fixed String

M

SY07

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

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

DistributionChannelDPID

The DDEX Party ID of the DistributionChannel.

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

DPID

C

DPIDA12345SDF

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

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

Territory

The Territory for which the Royalty is reported.

AVS

M

DE

RightsType

The RightsType for which the Royalty is reported.

AVS

M

MechanicalRight

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

Usages

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

Integer

M

1909

Users

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

Integer

O

323

Currency

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

AVS

M

EUR

NetRevenue

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

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

Decimal

C

1009.21

RightsController

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

String

O

TestCompany

RightsControllerPartyId

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

PartyId

O

DPIDA12345SDF

AllocatedUsages

The number of Usages allocated to the RightsController.

Multiple Decimals

O

123.2

AllocatedRevenue

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

This is sometimes called Amount Payable.

Decimal

M

234.12

AllocatedNetRevenue

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

Decimal

M

12.99

ExchangRateBaseCurrency

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

AVS

O

EUR

ExchangRateBaseCurrency

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

AVS

O

EUR

RecordType

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

Fixed String

M

SY09

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

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

Territory

The Territory for which the Sale/Usage is reported.

AVS

M

DE

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.

The type of Subscriber.

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

RightsController

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

String

O

SACEM

RightsControllerPartyID

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

PartyID

O

ISNI::0000000081266409

RightsType

The right utilised in broadscating the Resource.

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

AVS

C

MechanicalRight

TotalUsages

RightsControllerMarketShare

The ratio in percent between TotalUsages and AllocatedUsages

Decimal

ExchangRateBaseCurrency

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

AVS

O

EUR

VideoCategory

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

String

O

Sport

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.

UserChannelName

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

String

O

MontreuxComedy

IsMasterRecording

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

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

Boolean

O

true

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

ComposerAuthor

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

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

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

Multiple String

C

Johann Sebastian Bach

The PartyId(s) of the ComposerAuthor(s)

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

Arranger

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

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

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

Multiple String

C

August Wilhelmj

The PartyId(s) of the Arranger(s)

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

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

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

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

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.

WorkContributor

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

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

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

Multiple String

C

UMP

The PartyId(s) of the WorkContributor(s)

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

RecordType

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

Fixed string

M

AS03

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

ResourceReference

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

String

M

15

DspResourceId

The ProprietaryIdentifier of the Resource assigned by the MessageSender

String

M

12345678

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

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

ProprietaryId

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

String::String

O

BBC::12345

VideoType

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

Multiple AVSs

M

Title

The ReferenceTitle of the SoundRecording.

String

M

The Hamburger Postulate

SubTitle

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

String

O

Original Version

OriginalTitle

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

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

String

O

The Hamburger Postulate

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

EpisodeNumber

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

EpisodeNumber has to be provided for TV series episodes.

Integer

C

3

Genre

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

String

O

Horror Comedy

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

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

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

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

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

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

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

LanguageLocalizationType

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

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

AVS

C

Dubbed

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

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

LanguageOfPerformance

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

ISO Language Code

O

en

LanguageOfDubbing

The Language of dubbing used in the audio-visual Resource

ISO Language Code

O

de

ProductionOrReleaseDate

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

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

ISO date

C

2015

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

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

FirstVoDBroadcastDate

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

Date

O

2015-02-05

RecordType

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

Fixed string

M

MW01

BlockId

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

String

M

7

DspWorkId

The ProprietaryIdentifier of the Musical Work assigned by the MessageSender

String

M

12345678

ISWC

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

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

Title

The ReferenceTitle of the Musical Work

String

M

Bohemian Rhapsody

SubTitle

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

String

O

Live version

ComposerAuthor

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

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

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

Multiple String

C

Johann Sebastian Bach

The PartyId(s) of the ComposerAuthor(s)

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

Arranger

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

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

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

Multiple String

C

August Wilhelmj

The PartyId(s) of the Arranger(s)

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

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

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

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

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.

WorkContributor

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

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

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

Multiple String

C

UMP

The PartyId(s) of the WorkContributor(s)

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

DataProvider

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

String

O

UMG

RecordType

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

Fixed string

M

CU01

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

CueResourceReference

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

String

M

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

CueDuration

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

ISO duration

M

MP5S

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

ReferencedCreationISWC

The ISWC of the referenced Creation.

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

String

C

T9100085652

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

ReferencedCreationDisplayArtistName

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

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

Multiple Strings

O

Johnny Galecki|Jim Parsons|Kaley Cuoco

ReferencedCreationDisplayArtistPartyId

The PartyId of the ReferencedCreationDisplayArtistName.

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

Multiple PartyID

O

ISNI::0000000081266409|ISNI::0000000012345649|

ReferencedCreationCrontributorName

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

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

Multiple Strings

O

Johnny Galecki|Jim Parsons|Kaley Cuoco

ReferencedCreationContributorPartyId

The PartyId of the ReferencedCreationCrontributor.

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

Multiple PartyID

O

ISNI::0000000081266409|ISNI::0000000012345649|

ReferencedCreationComposerAuthorName

The Name of a creative Contributor of the referenced Creation.

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

Multiple Strings

O

Johnny Galecki|Jim Parsons|Kaley Cuoco

ReferencedCreationComposerAuthorPartyId

The PartyId of the ReferencedCreationComposerAuthor.

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

Multiple PartyID

O

ISNI::0000000081266409

ReferencedCreationArrangerName

The Name of an Arranger of the referenced Creation.

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

Multiple Strings

O

Johnny Galecki|Jim Parsons|Kaley Cuoco

ReferencedCreationArrangerPartyId

The PartyId of the ReferencedCreationArranger.

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

Multiple PartyID

O

ISNI::0000000081266409

RecordType

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

Fixed string

M

SU01

BlockId

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

String

M

7

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

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

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

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

IsRoyaltyBearing

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

Boolean

M

true

SalesUpgrade

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

Boolean

M

false

Usages

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

Integer

M

1000

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

PriceConsumerPaidExcSalesTax

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

PriceConsumerPaidExcSalesTax is mandatory when the CommercialModel is PayAsYouGoModel.

Decimal

C

100.34

PromotionalActivity

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

String

O

Valentines Day Special

RecordType

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

Fixed string

M

SU02

BlockId

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

String

M

7

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

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

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

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

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

NumberOfStreams

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

Integer

M

1000

PriceConsumerPaidExcSalesTax

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

PriceConsumerPaidExcSalesTax is mandatory when the CommercialModel is PayAsYouGoModel.

Decimal

C

100.34

PromotionalActivity

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

String

O

Valentines Day Special

RecordType

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

Fixed string

M

SU03

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

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

DspReleaseId

The ProprietaryIdentifier of the UGC Release assigned by the MessageSender

String

M

12345

Usages

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

Integer

C

400

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

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

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

ContentCategory

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

String

O

Music

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

RecordType

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

Fixed string

M

SU04

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

SummaryRecordId

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

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

String

M

7

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

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

TransactedResource

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

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

String

C

2345

DrmEnforcementType

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

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

AVS

C

NotDrmEnforced

VideoDefinitionType

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

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

AVS

C

HighDefinition

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

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

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

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

IsRoyaltyBearing

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

Boolean

M

true

SalesUpgrade

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

Boolean

M

false

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

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

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

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

PromotionalActivity

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

String

O

Valentines Day Special

OfferStartDate

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

ISO Date

O

2015-01-01

OfferEndDate

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

ISO Date

O

2015-01-12

OfferURL

The URL from where the Release transacted was available

String

O

http:/xxx.com/1234

5rgs

FirstVoDBroadcastDateTime

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

DateTime

O

2016-01-26T15:00:00Z

RecordType

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

Fixed string

M

SU05

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

SummaryRecordId

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

String

M

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.

String

M

34456

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

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

NumberOfBroadcasts

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

Integer

M

1000

NumberOfBroadcastListeners

The number of listeners to these Broadcasts.

Integer

O

10000

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

RecordType

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

Fixed string

M

RU01

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

DspReleaseId

The ProprietaryIdentifier of the UGC Release assigned by the MessageSender

Multiple Strings

M

12345|12346

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

RecordType

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

Fixed string

M

RU02

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

DspReleaseId

The ProprietaryIdentifier of the UGC Release assigned by the MessageSender

String

M

12345

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

ReleaseURL

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

String

M

http://test.te/view/1234

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

RecordType

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

Fixed string

M

LI01

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

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

C

RightsControllerWorkId

The ProprietaryId given to the MusicalWork used by the RightsContoller

String

O

12gc

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

AllocatedNetRevenue

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

Decimal

M

34567

AllocatedAmount

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

Decimal

M

2560.77

AllocatedUsages

The number of Usages allocated to the RightsController.

Decimal

O

10.5