5.6.4 SU04.02 – AV-specific Usage Record

Basic sales/usage Record for audio-visual sales/usages.

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

IsDrmEnforced (updated)

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

PriceConsumerPaidExcSalesTax

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

PriceConsumerPaidExcSalesTax is mandatory when the CommercialModelType is PayAsYouGoModel.

Decimal

O

100.34

19

PromotionalActivity

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

String

O

Valentines Day Special

20

OfferStartDate

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

ISO Date

O

2015-01-01

21

OfferEndDate

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

ISO Date

O

2015-01-12

22

OfferUrl

The URL from where the Release transacted was available

String

O

http:/xxx.com/1234

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

UseType (new)

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