5.6.5 SU04.03 — Sales and/or usage Record for audio-visual only services

This is the Record used to communicate data about sales and/or usage relating to releases or resources made available on an audio visual-specific or other similar service and is contained in a DSR message created in accordance with the Audio-visual Profile.

Cell Name

Definition

Data type

M/O/C

Example

1

RecordType

The type of the Record which shall always contain the value SU04.03.

Fixed string

M

SU04.03

2

BlockId

The identifier of the Block that this Record belongs to, which shall be specific to this DSR message. All Records in a single Block shall have the same BlockId.

String

M

7

3

SummaryRecordId

The identifier, which shall be specific to the DSR message, of the summary Record for which this sales and/or usage Record provides details.

This identifier shall be used in the sales and/or usage data Records to indicate to which summary Record they provide details.

String

M

34

4

SalesTransactionId

The proprietary identifier of the sales and/or usage Record, which is allocated by the licensee, and which enables any communication about a DSR message to reference directly back to an individual sales and/or usage Record.

The SalesTransactionId taken together with the MessageId in the HEAD Record shall be globally and perpetually unique. The SalesTransactionId may change if the DSR message has to be re-generated.

String

M

34456

5

TransactedRelease Reference

The identifier, specific to the Block, of the Record describing the release (either a head release or a sub-release) for which the sales and/or usage data is being reported. 

A value is mandatory in either the TransactedReleaseReference Cell or the TransactedResourceReference Cell.

String

C

2345

6

TransactedResource Reference

The identifier, specific to the Block, of the Record describing the resource for which the sales and/or usage data is being reported.

A value is mandatory in either the TransactedResourceReference Cell or the TransactedReleaseReference Cell.

String

C

2345

7

IsDrmEnforced

A flag which indicates if the release which is the subject of the Record was technically protected or not.

A value in the IsDrmEnforced Cell is mandatory if available to the licensee. This field is important for licensors for their processing and would ideally be mandatory in this part of the DSR standard. However, as there are rare cases where licensees genuinely do not have this data, the Cell is conditional.

Boolean

C

false

8

VideoDefinitionType

The description of the type of resolution (or definition) in which a video is provided to end users.

A value in the VideoDefinitionType Cell is mandatory if available to the licensee. This field is important for licensors for their processing and would ideally be mandatory in this part of the DSR standard. However, as there are rare cases where licensees genuinely do not have this data, the Cell is conditional.

AVS: Video Definition Type_DSR

C

HighDefinition

9

CodingType

A description of the type of coding in which a video is provided to end users. 

A value in the CodingType Cell is mandatory if available to the licensee. This field is important for licensors for their processing and would ideally be mandatory in this part of the DSR standard. However, as there are rare cases where licensees genuinely do not have this data, the Cell is conditional.

AVS: CodingType

C

Lossless

10

BitRate

The amount of data of the audiovisual content in a specific period of time, provided in kbps. 

A value in the BitRate Cell is mandatory if available to the licensee. This field is important for licensors for their processing and would ideally be mandatory in this part of the DSR standard. However, as there are rare cases where licensees genuinely do not have this data, the Cell is conditional.

Decimal

C

1.25

11

Original BroadcastChannel

The broadcast channel on which the release which is the subject of the Record was originally broadcast.

A value in the OriginalBroadcastChannel Cell is mandatory for services deemed to be “catch-up” television or streaming services.

String

C

BBC One

12

Original BroadcastDateTime

The date and, if available, time, of the original broadcast of the release which is the subject of the Record source in ISO 8601 format, PT[[hhH]mmM]ssS where lower case characters indicate variables and upper case characters are part of the string.

For example, one hour, two minutes and three seconds would be PT1H2M3S. The seconds section ss may include fractions. For example, one minute and 30.5 seconds would be PT1M30.5S.

A value in the OriginalBroadcastDateTime Cell is mandatory for services deemed to be “catch-up” television or streaming services.

Datetime

C

1999-10-27T20:00:00Z

13

IsRoyaltyBearing

A flag indicating whether the licensee is contractually obliged to pay royalties to the licensor for the sales and/or usage being reported in the Record.

Boolean

M

true

14

SalesUpgrade

A flag indicating whether the sales and/or usage data applies to an upgraded release where the value is true, or, not where the value is false

Boolean

M

false

15

Usages

The number of sales and/or usages to all end users of all the releases or resources, that are the subject of the Block in which this Record appears, on the licensee’s service, for the sales context, defined in the summary Record, during the reporting period, including any sales adjustments. Sales adjustments include for example, file failures.

All values in the Usages Cell which point to the same summary Record are aggregated into the value of the TotalUsages Cell in that summary Record. 

The exact definition of the term Usages may be determined by the bilateral agreement between the licensee and the licensor

Decimal

M

1000

 

16

Returns

The number of sales and/or usage of the releases or resources that were returned with refunds where relevant by all end users.

A value may be added to the Returns Cell  as a result of a reversal of a sales or usage during the period of reporting contained in a DSR message or because of an earlier error in a DSR message previously provided to a licensor by a licensee.

If no Returns are to be reported, the value for the Cell shall be 0.

Decimal

M

2

17

DurationUsed

The duration of the releases or resources that has actually been used by an end user using the ISO 8601 format, PT[[hhH]mmM]ssS, where lower case characters indicate variables and upper case characters are part of the string.

For example one hour, two minutes and three seconds would be PT1H2M3S. The seconds section ss may include fractions. For example, one minute and 30.5 seconds would be PT1M30.5S.

The value in the DurationUsed Cell may be less than the total duration of the releases or resources.

Duration

O

PT2M50S

18 (up-dated)

PriceEndUserPaid ExcSalesTax

A price paid by end users, excluding sales tax for each individual sale and/or usage in the CurrencyOfTransaction. This may be a nominal price.

A value in the PriceEndUserPaidExcSalesTax Cell is mandatory if the value for the CommercialModel Cell is PayAsYouGoModel.

Decimal

C

100.34

 

19

PromotionalActivity

The description of a type of promotional activity used to exploit the release.

The detailed definitions of the values used in the PromotionalActivity Cell are determine by the bilateral agreement between the licensee and the licensor. 

A value for PromotionalActivity Cell is mandatory if a specific promotional activity has been taking place during the period of the sales and/or usage data contained in a DSR message.

String

C

Valentines Day Special

20

OfferStartDate

The start date on which the release(s) or resource(s) which is/are the subject of the Record was first made available to end users.

Date

O

2015-01-01

21

OfferEndDate

The end date on which the release(s) or resource(s) which is/are the subject of the Record was first made available to end users.

Date

O

2015-01-12

22

OfferURL

The URL from where the transacted release(s) or resource(s) which is/are the subject of the Record was made available.

String

O

http:/example.com/1234

23 (up-dated)

Deprecated Cell (OriginalBroadcastDateTime)

24

UseType

A description of the way in which an end user uses a service.

The value in the UseType Cell also enables the communication of which type of device an end user has used to access the service. This is achieved by using the UseType value UseAsDevice.

A value in the UseType Cell is mandatory if there is no UseType in the relevant summary Record. Similarly, a value in the UseType Cell shall not be provided if there is a value in the UseType Cell of the relevant summary Record.

AVS: UseType_DSR

C

PermanentDowload

25 (new)

PlaybackDuration

The duration that all end users viewed or listened to the releases or resources during the reporting period. The total duration reported here relates to the duration of all playbacks of all releases or resources that embody musical works which to the knowledge of the licensee at the time of sending the DSR message are controlled by the rights controller or the licensor. 

The value in this Cell uses the ISO 8601 PT[[hhH]mmM]ssS format, where lower case characters indicate variables and upper case characters are part of the string.

For example, one hour, two minutes and three seconds would be PT1H2M3S). The seconds section ss may include fractions. For example, one minute and 30.5 seconds would be PT1M30.5S.

Duration

O

PT1H3M30.25S