5.6.2 SU01.03 — Sales and/or usage Record for download services

This is the Record used to communicate data about sales and/or usage relating to releases or resources made available on a download or other similar service and is contained in a DSR message created in accordance with the Basic Audio Profile, the Audio-visual Profile and the Basic Audio Profile for The Mechanical Licensing Collective.

Cell Name

Definition

Data type

M/O/C

Example

1

RecordType

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

Fixed string

M

SU01.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 Records shall be globally and perpetually unique. The SalesTransactionId may change if the DSR message has to be re-generated.

String

M

34456

5

TransactedReleaseReference

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

TransactedResourceReference

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

String

C

2345

7

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

8

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

9 (up-dated)

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

10

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 and/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

11

PriceEndUserPaidExcSalesTax

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

12

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

O

Valentines Day Special

 

13

UseType

A description of the way in which an end users 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