8.1 File naming convention

All files that make up a Sales/Usage Report shall be named in accordance with the following syntax:

DSR_MessageRecipient_MessageSender_ServiceDescription_MessageNotificationPeriod_TerritoryOfUseOrSale_xofy_MessageCreatedDateTime.ext

The following defines what each element of the syntax means.

MessageRecipient

The party name or DDEX Party ID (DPID) of the licensor.

The MessageRecipient may be omitted if the Sales/Usage Report is sent to more than one licensor.

This data shall be the same as the data conveyed in the HEAD Record in the RecipientPartyId or RepresentedRepertoire Cell. The MessageRecipient may only contain a name or identifier for a RepresentedRepertoireif the Sales/Usage Report is only covering one such repertoire.

DDEX Party IDs do not contain special characters (including dashes).

MessageSender

The party name or DDEX Party ID (DPID) of the licensee or, where appropriate, the entity on behalf of whom the Sales/Usage Report is sent.

This data shall be the same as the data conveyed in the HEAD Record in the SenderPartyId Cell or in the DistributionChannelDpid as provided in the relevant summary Record.

The MessageSender may only contain a DistributionChannelDpid if the Sales/Usage Report is only covering one such distribution channel.

DDEX Party IDs do not contain special characters (including dashes).

Service Description

A description of the service name (e.g. a service tier) to be reported on. Multiple tiers can be communicated by separating them with dashes (Unicode U+2010).

This data shall be the same as the data conveyed in the HEAD Record.

Message Notification Period

The reporting period covered by the Sales/Usage Report in accordance with ISO 8601:2004. The only allowed syntaxes are:

  • yyyy for a year

  • yyyy-mm for a month

  • yyyy-mm-dd for a day

  • yyyy-Qq for a quarter

  • yyyy-www for a week (starting on a Monday)

  • yyyy-mm-dd--yyyy-mm-dd with the two dates being the start and end date of the period as signified by the two dashes between the two dates.

Territory OfUseOrSale

The territory(ies) for which the sales and/or usage data in the Sales/Usage Report are reported.

The TerritoryOfUseOrSale shall be provided as a single ISO Territory Code if one territory is to be communicated. Otherwise, the licensee and the licensor shall agree a value acceptable to both/all.

xofy

The file counter.

For example, the 7th file of a 9-file Sales/Usage Report would be 7of9. This element may be omitted when the Sales/Usage Report is contained in a single file.

MessageCreated DateTime

The date and time on which the Sales/Usage Report was created. The only allowed format is the full basic zero-padded ISO 8601 format without a time zone designator with optional milliseconds: yyyyymmddThhmmss[mmm]. The time zone is assumed to be the one of the licensee’s location. 20220304T123255020 would represent 12:32:55.020 on 4th March 2022.

ext

The file extension, to be .tsv.

When the file is compressed, for example with gzip, the extension should indicate this and may be .tsv.gz.

The following constraints apply in respect of the elements of the file naming syntax:

  1. None of the file name elements may contain an underscore character;

  1. None of the file name elements may contain a space character;

  1. When a file name element is to be omitted, the two underscore characters to the left and right follow each other immediately (for example, TerritoryOfUseOrSale__MessageCreatedDateTime);

  1. Other file naming conventions may be agreed between the licensor and the licensee (specifically for testing).

Search