1

RecordType

The type of the record which shall always contain the value CDMH.01.

Fixed string

M

CDMH.01

2

MessageVersion

The version of the CDM message.

This shall be in the form CDM/xxx/yyy/zzz with:

• xxx being the version number of Part 1: Architecture;

• yyy being the identifier of the version of the allowed-value sets used in the CDM message; and

• zzz being the version number of Part 2: Record type definitions (this document) that is needed to ingest the CDM message. This document is version 2.0 of the Record type definitions part of the CDM standard.

The specific value for the architecture is provided in each of the parts defining a profile for this standard.

The value CDM/2.2/5.0/4.2 would therefore signal that the CDM message was created in accordance with the architecture in version 2.2, with the allowed-value set of version 5.0 and with the Record type definitions of 4.2.

Fixed string

M

CDM/2.2/5.0/4.2

3

MessageId

A string used to uniquely identify the CDM message. The MessageId shall be, in combination with the MessageSenderId, globally unique. Thus, a MessageSender shall never re-use a MessageId.

String

M

1234567890

4

MessageCreated DateTime

The date and time at which the message was created (the only allowed format is RfC 3339: YYYY-MM-DDThh:mm:ssTZD, where TZD stands for time zone designator, which can be the letter Z or an offset from UTC in the format +hh:mm or -hh:mm).

Datetime

M

2014-12-14T10:05:00Z

5

Profile

The identifier of the profile used for the CDM message.

AVS:ProfileId_CDM

M

ClaimsCorrections

6

ProfileVersion

The identifier of the version of the profile used for the CDM message. The value of this Cell in defined in the relevant profile of the CDM standard.

String

M

1.0

7

RelatedCdm MessageId

The MessageId of a previously communicated CDM Statement (or as determined by the bilateral agreement between the licensee and the licensor claim data in another format) that the current CDM Statement is either retracting completely or is providing corrections to.

The value in the RelatedCdmMessageId Cell is mandatory if the CDMH.01 Record is part of a CDM Statement that is a retraction of a previously communicated CDM Statement.

The value in the RelatedCdmMessageId Cell is also mandatory if the CDMH.01 Record is part of a CDM Statement containing correction(s) to a previously communicated CDM Statement.

The RelatedCdmMessageId Cell shall remain empty if the CDMH.01 Record appears in a CDM Statement which is the first communication from a licensor as a response to a DSR Message.

This Cell may not be used for CDM Notification of Overclaim Discrepancies. Where a licensee is sending a CDM Notification of Overclaim Discrepancies the CDMMessageId in the CDD2.01 Record should be used as the mechanism to identify previously received communications.

String

C

1234567890

8

SalesReportId

The MessageId of the DSR Message to which this message is a response. 

SalesReportId is mandatory if the DSR Message contains a message identifier.

String

C

0987654321

9

UsageStartDate

The start date of the reporting period covered by the DSR Message, and therefore the CDM Statement, to which this is a response in ISO 8601:2004 format. This is a string with the syntax YYYY[-MM[-DD]].

The value in the UsageStartDate Cell in this CDMH.01 Record may be different from the value in the StartOfClaimPeriod Cell in the summary Records if permitted by the bilateral agreement between the licensee and the licensor.

ISO date

C

2014-12-01

10

UsageEndDate

The end date of the reporting period covered by the DSR Message, and therefore this CDM Statement, to which this is a response in ISO 8601:2004 format. This is a string with the syntax YYYY[-MM[-DD]].

The value in the UsageEndDateCell in this CDMH.01 Record may be different from the value in the EndOfClaimPeriod in the summary Records, if permitted by the bilateral agreement between the licensee and the licensor.

ISO date

C

2014-12-01

11

SenderPartyId

The DDEX Party ID (DPID) of the message sender.

DDEX Party ID

M

PADPIDA2008120501W

12

SenderName

The full name of the message sender.

String

M

GEMA

13

ServiceDescription

The service name to which the data in the CDM message relates. The ServiceDescription is intended to be a human-readable expression of the totality of the service(s) to which the CDM message relates.

The CDM message may be only in respect of one service offering/tier under the ServiceDescription name and is determined by the bilateral agreement between the licensee and the licensor.

In most cases, this Cell will contain a value for the ServiceDescription which is the same value as appears in the DSR Message to which the CDM message is a response.

The value in the ServiceDescription Cell may not contain space characters or underscores.

String

C

PremiumService

14

RecipientPartyId

The SenderPartyId of the DSR Message to which the CDM message is a response.

A value in the RecipientPartyId Cell is mandatory if a value appears in the SenderPartyId Cell in the DSR Message to which the CDM message is a response.

DDEX Party ID

O

PADPIDA2007081601G

15

RecipientName

The SenderName of the DSR Message to which the CDM message is a response.

String

O

YouTube

16

ClaimingRound

The cardinal number which identifies the number of times a licensor has provided a CDM Statement in respect of a particular DSR Message, known as a claiming round.

A value in the ClaimingRound Cells is mandatory if required by the bilateral agreement between the licensee and the licensor.

Integer

C

1

17 (new)

SentOnBehalfOf PartyId

The DDEX Party ID (DPID) of the RightsController or licensor, as determined by the bilateral agreement between the licensee and the licensor on whose behalf the CDM Statement is being sent. 

A value in the SentOnBehalfOfPartyId Cell is mandatory if the CDM Statement is being sent on behalf of an entity that is different from the message sender, usually the licensor.

If the CDMH.01 Record is being used in a CDM Notification message the SentOnBehalfOfPartyId Cell may be left blank.

DDEX Party ID

C

PADPIDA2007081601G

18 (new)

SentOnBehalfOfName

The name of the RightsController or licensor, as determined by the bilateral agreement between the licensee and the licensor on whose behalf the CDM Statement is being sent.

A value in the SentOnBehalfOfName Cell is mandatory if the CDM Statement is being sent on behalf of an entity that is different from the message sender, usually the licensor.

If the CDMH.01 Record is being used in a CDM Notification message the SentOnBehalfOfName Cell may be left blank.

String

C

Universal Music Publishing