ONIX for Repertoire: application guidelines

Transcription

1 ONIX for Repertoire: application guidelines Pilot 2: PLS to CLA use cases: change terms, February 2008 CONTENTS LIST Page Introduction...1 Principles...2 Change Terms notification guidelines...3 RepertoireDetail...7 DetailByResource...10 DetailByResourceClass...13 PriceDefinition...15 Example 1: Use Case 3.1, change terms...17 Example 2: Use Case 3.2, exclude title from all licences...22 Example 3: Use Case 3.3, exclude non-mandating PRC s repertoire from all licences...24 Pilot applications were based on interim versions of the ONIX-RP format. Immediately before Version 1.0 was released, and arising from experience in the pilots, a number of final modifications and corrections were made to the format specification, and these may not all be reflected in the pilot documentation. Please note that, where there is any discrepancy between the pilot guidelines and the Version 1.0 ONIX for Repertoire: message format overview, the overview should be taken as authoritative. Introduction This document provides guidelines and worked examples for one of the groups of PLS-to- CLA ONIX-RP use cases analysed as part of Pilot Project 2. The guidelines take the form of a table whose first three columns are a compressed version of the ONIX-RP Overview. The fourth column shows typical content for each individual element, colour-coded to indicate dictionary terms, labels and other data strings in the same way as in other ONIX documentation. (For composite elements, the column carries the word Composite, since in this case the content comprises the included elements.) The fifth column carries application notes and business rules. Elements in the format that are not used are shaded out in grey. Following the guidelines, examples are given of a number of individual use cases. Each use case is briefly described, and the main elements are summarised, followed by a complete XML example.

2 Principles The principles noted here apply specifically to the PLS-to-CLA implementation. They may not necessarily apply to other ONIX-RP implementations. 1. In PLS and CLA practice a repertoire comprises all the titles for which rights are controlled by a publisher (or more accurately a publishing rights controller, or PRC ). Any titles that the PRC chooses to exclude from all CLA and CLA partner licences are still to be regarded as part of its repertoire. 2. In some cases where a large publisher designates different business units to be responsible for different parts of its output (typically for books and journals), PLS treats each business unit as a separate PRC, each with its own mandate and its own repertoire. 3. PLS sends a Change Terms notification to CLA in the following circumstances only: (a) When a mandating PRC has notified PLS that it wishes to change the terms applying to designated parts of its repertoire, normally expressed as lists of titles and/or classes of title. (b) Exceptionally, when PLS has received a request from a non-mandating publisher for the whole of its repertoire to be excluded from all licences. 4. A Change Terms notification may reference any part of the repertoire belonging to a mandating PRC, from a single title upwards. The notification must fully specify licence inclusions/exclusions and prices for every title (or class of title) to which it refers. 5. It is understood that PLS and CLA will share a common name identifier scheme which applies to PRCs, subsidiaries and imprints. PLS will use the PRC s name identifier, taken from this scheme, as the Repertoire Identifier which is required in all Repertoire Notifications. 6. In any Repertoire Notification, where a class of title is specified (eg all printed journals), and some titles in that class are individually listed, the individual listings always take precedence over the listing by class. However, if a change terms notification specifies a class without listing any individual exceptions, then it must be assumed that the new terms apply to the whole of the class, even if some members of the class have previously been designated as exceptions. If the exceptions are intended to remain in force, they must be restated in the change terms notification. To avoid any ambiguity in this respect, it is expected that if a change terms notification sent by PLS to CLA refers to a class, it will always list all previous exceptions belonging to the class, regardless of whether they have been subject to change. 7. At the time of the release of ONIX-RP Version 1.0, local values to be used by CLA and PLS in a ukrro: namespace in a number of coded data elements had not been finalised. Provisional or illustrative values are shown throughout in green. 2

3 Change Terms notification guidelines 1 <RepertoireNotification> A composite that notifies new or changed 1-n Composite repertoire 2 <NotificationType> An ONIX controlled value specifying a type of 1 ifrro:changeterms a Repertoire Notification 3 <ReasonForNotification> An ONIX controlled value specifying a reason for sending a Repertoire Notification 0-1 ifrro:mandatorrequest ifrro:mandatetermination ifrro:nonmandatorrequest ifrro:correction Mandatory in this use case 4 <NotificationID> A sender-assigned identifier that is unique within the sequence of Repertoire Notifications sent by the Sender to the Addressee 5 <NotificationEffectiveDate> The date on which the changes notified in the Repertoire Notification become effective, expressed as YYYYMMDD 6 <RepertoireIdentifier> A composite that uniquely identifies a Repertoire; repeatable only if two or more identifiers of different types are sent. 7 <RepertoireIDType> An ONIX controlled value identifying the scheme from which the identifier in the <IDValue> element is taken /003 Suggested format is: message number / notification sequence number within message When not sent, the default is today s date 1-n Composite One occurrence only in this use case 1 ukrro:plsrepertoireid It has been suggested that PLS will use its PRC identifier as the repertoire identifier. 8 <IDTypeName> A name of a proprietary scheme, if applicable 0-9 <IDValue> An identifier of the type specified in the <RepertoireIDType> element 10 <RepertoireDescription> A title or description given by the sender to the repertoire to which a Repertoire Notification refers 11 <RepertoireAnnotation> A composite that carries an annotation relating to the repertoire to which a Repertoire Notification refers 12 <RepertoireAnnotationType> An ONIX controlled value specifying the type of the annotation 1 PLS This represents the probable format of the ID, subject to confirmation 0-1??????? The form of title or description (if any) to be assigned to a repertoire by PLS is to be determined 0-13 <AnnotationText> The text of the annotation 14 <RepertoireRelatedAgent> A composite that specifies an Agent that is related to a repertoire, and its relationship to the repertoire 0-n Composite Mandatory in this use case, one occurrence only Copyright EDItEUR & IFRRO 3

4 15 <RepertoireAgentRelator> An ONIX controlled value specifying a relationship between a repertoire and a related agent or agent class 16 <AgentIdentifier> A composite that carries an identifier of an agent or agent class 17 <AgentIDType> An ONIX controlled value identifying the scheme from which the identifier in the <IDValue> element is taken 1 ukrro:hasmandatingprc ukrro:hasnonmandating PRC 0-n Composite Mandatory in this use case; one occurrence must give the PRC s name ID. A second occurrence may be used to send an EIN Number, if it has been notified. 1 ukrro:plsclanameid ifrro:einnumber 18 <IDTypeName> A name of a proprietary scheme, if applicable 0-19 <IDValue> An identifier of the type specified in the <AgentIDType> element It is understood that PLS and CLA will share a common name identifier, assumed here to be used for publisher and imprint names 1??????? The format of PLS/CLA name identifiers is to be determined 20 <Name> A name of an agent or agent class 0-1 PRC name Mandatory in this use case 21 <AgentAnnotation> A composite that carries an annotation relating to an agent, typically used to carry an explanatory note about a rights controller 22 <AgentAnnotation Type> An ONIX controlled value specifying the type of the annotation 0-n Composite Used as necessary to carry a note about a PRC 0-23 <AnnotationText> The text of the annotation 1 Free text 24 <AgentRelatedName> A composite that specifies a name, typically of an imprint or subsidiary, that is related to an agent. Listing of names here means that they do not limit the scope of the repertoire, but indicates that publications bearing these names are normally controlled by the rights controller identified in <RepertoireRelated Agent>. 25 <AgentNameRelator> An ONIX controlled value specifying a 0- relationship between an agent and a related name 26 <NameIdentifier> A composite that carries an identifier of a related name 27 <NameIDType> An ONIX controlled value identifying the scheme from which the identifier in the <IDValue> element is taken 28 <IDTypeName> A name of a proprietary scheme, if applicable 0-29 <IDValue> An identifier of the type specified in the <NameIDType> element Copyright EDItEUR & IFRRO 4

5 30 <Name> A name of an imprint or subsidiary 0-31 <NameAnnotation> A composite that carries an annotation relating to a name, typically used to carry an explanatory note about an imprint 32 <NameAnnotationType> An ONIX controlled value specifying the type of the annotation 0-33 <AnnotationText> The text of the annotation 34 <RepertoireRelatedMandate> A composite that specifies a mandate that is related to a repertoire, and its relationship to the repertoire 35 <RepertoireMandateRelator> An ONIX controlled value specifying a relationship between a repertoire and a related mandate 36 <MandateIdentifier> A composite that carries an identifier of a mandate 37 <MandateIDType> An ONIX controlled value identifying the scheme from which the identifier in the <IDValue> element is taken 0-n Composite One instance may be sent in a Change Terms notification to identify the mandate in relation to which the notification is sent. Not used if the notification relates to a non-mandating PRC. 1 ifrro:hasmandate ifrro:hasformermandate 0-n Composite One instance is mandatory in this use case 1 ukrro:plsmandateid The PLS Mandate ID will also be held in the CLA system 38 <IDTypeName> A name of a proprietary scheme, if applicable 0-39 <IDValue> An identifier of the type specified in the <MandateIDType> element 1 PLS <Name> A name of a mandate 0-41 <MandateRelatedTimePoint> A composite that specifies a date that is related to a mandate, and its relationship to the mandate 0-1 Composite Not used 42 <MandateTimePointRelator> An ONIX controlled value specifying a relationship between a mandate and a related time point 43 <TimePointIdentifier> A composite that carries an identifier of a time point 1 Composite Not used 44 <TimePointIDType> An ONIX controlled value specifying a form of a time point identifier, eg YYYY 45 <IDTypeName> A name of a proprietary scheme, if applicable 0-46 <IDValue> A time point identifier in the form specified in the <TimePointIDType> element Copyright EDItEUR & IFRRO 5

6 47 <RepertoireDefinitionType> An ONIX controlled value that specifies whether a repertoire is defined by the resources specified in successive <Repertoire Detail> elements, or otherwise (eg as all eligible resources controlled by a mandating rights controller) 48 <Definitions> A composite that defines entities referred to in a Repertoire Notification only PriceDefinition is used in this version of ONIX-RP 49 <PriceDefinition> A composite that defines a price that is referred to in a Repertoire Notification 50 <UsageDefinition> A composite that defines a usage referred to in a Repertoire Notification: at present, this is a placeholder only the expansion will be added when found necessary 51 <RepertoireDetail> A composite that specifies rights and resources that together form part of a repertoire: repeat for each part of the repertoire that has different delegated rights and/or pricing 52 <ResourcesExcluded> A composite that specifies resources to be excluded completely from a repertoire 53 <DetailByResource> A composite that specifies a resource expansion as in <RepertoireDetail> 54 <DetailByResourceClass> A composite that specifies a resource class, together with any exclusions from that class expansion as in <RepertoireDetail> Composite Required if one or more publisher-set prices are specified in a notification 1-n Composite Required if one or more publisher-set prices are specified in a notification 1-n Composite See next page 0-1 Composite Not used Copyright EDItEUR & IFRRO 6

7 RepertoireDetail 1 <RepertoireDetail> A composite that specifies rights and resources that together form part of a repertoire 1-n Composite One occurrence only in this use case. 2 <DelegatedRightByLicense> A composite that specifies license inclusions and/or exclusions, and if applicable prices, that apply to part of a repertoire 3 <IncludeUnderLicense> A composite that specifies a license or package of licenses under which specified resources are included 4 <LicenseType> An ONIX controlled value that uniquely identifies either a single license (eg CCC APS) or a package of licenses (eg all PLS/CLA core licences) 5 <UsageWithinLicense> A composite that specifies a usage type within a license type that is specifically permitted or prohibited: this is a placeholder, to be fully defined when the requirement is clear 6 <SubjectToPayment> Either (a) an ONIX controlled value specifying a price class, or (b) a label assigned in a Price Definition to identify a price set by a rights controller. Specifies payment(s) applying to usage under the license type(s) listed in preceding <IncludeUnderLicense> elements. 7 <ExcludeFromLicense> A composite that specifies a license or license class from which specified resources must be excluded expansion as for <IncludeUnder License> 8 <LicenseType> An ONIX controlled value that uniquely identifies either a single license (eg CCC APS) or a package of licenses (eg all PLS/CLA core licences) 9 <WithinTerritory> A composite that specifies a territory for which rights are delegated 10 <PlaceIDType> An ONIX controlled value specifying a scheme from which a place identifier is taken, eg ISO country codes 0-n Composite Mandatory in this use case, one occurrence only. 0-n Composite 1 To be defined PLS and CLA will define a list of individual licenses and license packages suitable for this application 0-n ukrro:cladefault UserDefinedPriceLabel 0-n Composite 1 To be defined Omitted if the licence(s) specified in LicenseType do not have any pricing options. Otherwise one occurrence specifying either a default or a publisher-set price from a PriceDefinition. Multiple occurrences would arise if a license specified both a flat fee per transaction and a volume-based fee. Copyright EDItEUR & IFRRO 7

8 11 <IDValue> A value from the specified scheme, repeatable (eg) for multiple countries 12 <FromTimePoint> A composite that specifies a time from which a delegation of rights is effective 13 <TimePointIDType> An ONIX controlled value specifying a form of a time point identifier, eg YYYY 14 <IDValue> A time point identifier in the form specified in the <TimePointIDType> element 15 <ToTimePoint> A composite that specifies a time to which a delegation of rights is effective 16 <TimePointIDType> An ONIX controlled value specifying a form of a time point identifier, eg YYYY 17 <IDValue> A time point identifier in the form specified in the <TimePointIDType> element 18 <DelegatedRightByUsage> A composite that specifies a usage for which all or part of a repertoire may be licensed by the delegate 19 <LicensableUsage> Either (a) an ONIX controlled value specifying a usage or usage class as a defined term, or (b) a label assigned in a Usage Definition to identify a usage or usage class 20 <WithinTerritory> A composite that specifies a territory for which rights are delegated: expansion as in line 7 above 21 <PlaceIDType> An ONIX controlled value specifying a scheme from which a place identifier is taken, eg ISO country codes 22 <IDValue> A value from the specified scheme, repeatable (eg) for multiple countries 23 <FromTimePoint> A composite that specifies a time from which a delegation of rights is effective: expansion as in line 10 above 24 <TimePointIDType> An ONIX controlled value specifying a form of a time point identifier, eg YYYY 25 <IDValue> A time point identifier in the form specified in the <TimePointIDType> element 1-n Not used 0-1 Composite Not used 0-1 Composite Not used 1-n Not used 0-1 Composite Not used Copyright EDItEUR & IFRRO 8

9 26 <ToTimePoint> A composite that specifies a time to which a delegation of rights is effective: expansion as in line 13 above 27 <TimePointIDType> An ONIX controlled value specifying a form of a time point identifier, eg YYYY 28 <IDValue> A time point identifier in the form specified in the <TimePointIDType> element 29 <UsageQuantity> A composite that specifies a quantity attribute of a usage, eg an extent or volume limit permitted for the usage 30 <UsageQuantityType> An ONIX controlled value specifying a type of a quantity 0-1 Composite Not used 31 <UsageQuantityDetail> A composite that carries details of a quantity 1-n Composite Not used 32 <Proximity> An ONIX controlled value specifying a relationship between a quantity and the <Value> stated in the composite, eg is less than, is not more than ; the default is is exactly 0-33 <Value> A decimal numeric value 34 <MeasureUnit> An ONIX controlled value specifying a unit of measure 35 <ReferenceUnit> An ONIX controlled value specifying a unit to which a quantity refers, if this is not implied by the <UsageQuantityType> 36 <SubjectToPayment> Either (a) an ONIX controlled value specifying a price class, or (b) a label assigned in a Price Definition to identify a price set by a rights controller. Specifies payment(s) applying to a usage. 37 <WholeRepertoireExceptAs Specified/> An XML empty element that indicates that the preceding delegated rights detail applies to the whole of the repertoire except for any resources or resource classes that are specified in separate <RepertoireDetail> elements. In other words, it establishes default delegated rights detail for a repertoire. If this element is present, there must be no <DetailByResource> or <DetailBy Resource Class> elements in the same instance of <RepertoireDetail>. 0-1-n Not used 0-1 Empty element Used when specifying the default terms for a repertoire, or a set of terms that applies to the whole repertoire (when no other <Repertoire Detail> elements are present) Copyright EDItEUR & IFRRO 9

10 DetailByResource 38 <DetailByResource> A composite that specifies a resource. Used where Repertoire Detail is expressed wholly or partly in terms of individual titles. Repeat for each title listed in the Repertoire Detail composite. 0-n Composite 39 <ResourceCategory> A composite that specifies a category to which a resource belongs 40 <ResourceCategoryType> An ONIX controlled value specifying a scheme from which a resource category is taken 41 <CategoryTypeName> A name of a proprietary scheme, if applicable 0-42 <CategoryValue> An category value from the specified scheme 43 <ResourceIdentifier> A composite that carries a unique identifier of a resource 44 <ResourceIDType> An ONIX controlled value specifying a scheme from which a resource identifier is taken 0-n Composite One occurrence only to carry an ISBN-13 or ISSN, mandatory in this use case. 1 ifrro:isbn13, ifrro:issn, ifrro:doi, etc 45 <IDTypeName> A name of a proprietary scheme, if applicable 0-46 <IDValue> An identifier value from the specified scheme <ResourceTitle> A composite that carries a title of a resource 0-n Composite Optional 48 <TitleType> An ONIX controlled value specifying the type 0- of a title 49 <TitleText> The text of the title 1 50 <Subtitle> A subtitle associated with a title <Contributor> A composite that identifies and/or names a single author or other contributor in a structured form 52 <ContributorRole> An ONIX controlled value specifying a role that is played by a contributor to a resource, eg author 53 <ContributorIdentifier> A composite that carries an identifier of a contributor: either a <ContributorIdentifier> or a name (or both) must be present in any instance of the <Contributor> composite 54 <ContributorIDType> An ONIX controlled value identifying the scheme from which the identifier in the <IDValue> element is taken 0-n Composite Optional, and not to be regarded as authoritative 1 0-n Composite 1 Copyright EDItEUR & IFRRO 10

11 55 <IDTypeName> A name of a proprietary scheme, if applicable 0-56 <IDValue> An identifier of the type specified in the <ContributorIDType> element 1 57 <PersonName> A composite that specifies a name of a person 0-n Composite 58 <PersonNameForm> An ONIX controlled value identifying a form of 0- a person name 59 <Name> A name of a person (in the form specified, if <PersonNameForm> is included) 1 60 <OrganizationName> A composite that specifies a name of an organization 0-n Composite 61 <OrganizationNameForm> An ONIX controlled value identifying a form of an organization name 0-62 <Name> A name of a person (in the form specified, if <OrganizationNameForm> is included) 1 63 <Publisher> A composite that identifies and/or names a single publisher in a structured form 64 <PublishingRole> An ONIX controlled value specifying a role that is played by a publisher of a resource 65 <PublisherIdentifier> A composite that carries an identifier of a publisher: either a <PublisherIdentifier> or a <Name> (or both) must be present in any instance of the <Publisher> composite 66 <PublisherIDType> An ONIX controlled value identifying the scheme from which the identifier in the <IDValue> element is taken 67 <IDTypeName> A name of a proprietary scheme, if applicable 0-68 <IDValue> An identifier of the type specified in the <PublisherDType> element 69 <Name> A name of a publisher 0-70 <Imprint> A composite that identifies and/or names an imprint or brand in a structured form 0-1 Composite Optional 71 <ImprintIdentifier> A composite that carries an identifier of an imprint or brand: either an <ImprintIdentifier> or a <Name> (or both) must be present in any instance of the <Imprint> composite 0-n Composite 72 <ImprintIDType> An ONIX controlled value specifying a scheme from which an imprint identifier is taken 1 ukrro:plsclanameid Copyright EDItEUR & IFRRO 11

12 73 <IDTypeName> A name of a proprietary scheme, if applicable 0-74 <IDValue> An identifier value from the specified scheme 1 PLS <Name> A name of an imprint or brand 0-1 Harper Reference Mandatory in this use case if <Imprint> is included 76 <ResourceRelated Resource> A composite that specifies a resource that is related to a resource: used here typically in order to specify a parent resource of which the listed resource is a part eg in the case of an article from a journal 77 <ResourceResource Relator> An ONIX controlled value specifying a relationship of a resource to a resource 78 <ResourceIdentifier> A composite that carries an identifier of a resource 79 <ResourceIDType> An ONIX controlled value specifying a scheme from which a resource identifier is taken 0-n Composite Used only if the listed resource is an Open Access article, to specify the journal in which it is published 1 ifrro:ispartof 1 Composite 1 ifrro:issn 80 <IDTypeName> A name of a proprietary scheme, if applicable 0-81 <IDValue> An identifier value from the specified scheme <ResourceRelatedTimePoint> A composite that specifies a time point that is related to a resource: used here in order to specify a date at which a run of a serial resource begins or ends: only the two elements shown below are used in this context 83 <ResourceTimePointRelator> An ONIX controlled value specifying a relationship of a time point to a resource 84 <TimePointIdentifier> A composite that carries an identifier of a time point 85 <TimePointIDType> An ONIX controlled value specifying a form of a time point identifier, eg YYYY 0-n Composite Used only if the listed resource is a run of serial issues defined by a start and/or end date 1 ifrro:publishedfromdate ifrro:publishedtodate 1 Composite 1 ifrro:yyyy ifrro:yyyymm ifrro:yyyymmdd 86 <IDTypeName> A name of a proprietary scheme, if applicable 0-87 <IDValue> A time point identifier in the form specified in the <TimePointIDType> element Copyright EDItEUR & IFRRO 12

13 DetailByResourceClass 88 <DetailByResourceClass> A composite that specifies a resource class that is part of a repertoire, together with any exclusions from that class 89 <ResourceCategory> A composite that specifies a category to which a resource belongs 90 <ResourceCategoryType> An ONIX controlled value specifying a scheme from which a resource category is taken 0-n Composite 0-n Composite 1 ukrro:resourceclass 91 <CategoryTypeName> A name of a proprietary scheme, if applicable 0-92 <CategoryValue> An category value from the specified scheme 1 To be defined 93 <ResourceRelatedAgent> A composite that specifies an agent that is related to a resource class, and its relationship to the resource class 0-n Composite 94 <ResourceAgentRelator> An ONIX controlled value specifying a 1 ukrro:hasprc relationship between a resource and a related agent or agent class 95 <AgentIdentifier> A composite that carries an identifier of an agent or agent class: either an <Agent Identifier> or a <Name> (or both) must be present in any instance of the <Resource RelatedAgent> composite 0-n Composite 96 <AgentIDType> An ONIX controlled value identifying the 1 ukrro:plsclanameid scheme from which the identifier in the <IDValue> element is taken 97 <IDTypeName> A name of a proprietary scheme, if applicable 0-98 <IDValue> An identifier of the type specified in the <AgentIDType> element 1 PLS <Name> A name of an agent or agent class 0-1 Publisher name 100 <ResourceRelatedTimePoint> A composite that specifies a time point that is related to a resource: used here in order to specify a date at which a run of a serial resource begins or ends: only the two elements shown below are used in this context 101 <ResourceTimePointRelator> An ONIX controlled value specifying a relationship of a time point to a resource 102 <TimePointIdentifier> A composite that carries an identifier of a time point 0-n Composite Used only if the resource class refers to serial publications issued during a period defined by a start and/or end date, eg if the PRC sets different prices for older and newer material 1 ifrro:publishedfromdate ifrro:publishedtodate 1 Composite Copyright EDItEUR & IFRRO 13

14 103 <TimePointIDType> An ONIX controlled value specifying a form of a time point identifier, eg YYYY 1 ifrro:yyyy ifrro:yyyymm ifrro:yyyymmdd 104 <IDTypeName> A name of a proprietary scheme, if applicable <IDValue> A time point identifier in the form specified in the <TimePointIDType> element <ResourceRelatedPlace> A composite that specifies a place that is related to a resource class, and its relationship to the resource class 107 <ResourcePlaceRelator> An ONIX controlled value specifying a relationship between a resource and a related place 108 <PlaceIdentifier> A composite that carries an identifier of a place 109 <PlaceIDType> An ONIX controlled value identifying the scheme from which the identifier in the <IDValue> element is taken 110 <IDTypeName> A name of a proprietary scheme, if applicable <IDValue> An identifier of the type specified in the <PlaceIDType> element 112 <Name> A name of a place <ResourceRelatedName> A composite that specifies a name, typically of an imprint or subsidiary, that is related to a resource class, and its relationship to the resource class. An imprint or subsidiary name is listed here only if it defines a section of a repertoire, eg with different terms from the rest. 0-n Composite 114 <ResourceNameRelator> An ONIX controlled value specifying a relationship between a resource and a related name 115 <NameIdentifier> A composite that carries an identifier of a related name: either a <NameIdentifier> or a <Name> (or both) must be present in any instance of the <ResourceRelatedName> composite 116 <NameIDType> An ONIX controlled value identifying the scheme from which the identifier in the <IDValue> element is taken 1 ifrro:hasimprintname ifrro:hassubsidiaryname 0-n Composite Mandatory in this use case, one occurrence only 1 ukrro:plsclanameid 117 <IDTypeName> A name of a proprietary scheme, if applicable 0- Copyright EDItEUR & IFRRO 14

15 118 <IDValue> An identifier of the type specified in the <NameIDType> element 1 PLS <Name> 0-1 Harper Reference Mandatory in this use case 120 <ExcludingResources> A composite that specifies resources or resource classes to be excluded from the class specified in an instance of <DetailByResourceClass> 0-1 Composite Not used 121 <DetailByResource> A composite that specifies a resource: expansion as from line <DetailByResourceClass> A composite that specifies a resource class: expansion as from line 49 PriceDefinition 1 <PriceDefinition> A composite that defines a price that is referred to in a Repertoire Notification 2 <PriceLabel> A label assigned here to the price for unambiguous internal reference within the ONIX <RepertoireNotification> document only 3 <PriceAnnotation> A composite that carries an annotation relating to a price 4 <PriceAnnotationType> An ONIX controlled value specifying the type of an annotation 1-n Composite Used only if the repertoire includes titles with publisher-set prices. One occurrence for each publisher-set price that is specified in the Repertoire Notification. 1 UserDefinedPriceLabel Values may be assigned as desired, provided that each price has a label that is unique within the Repertoire Notification (NB not necessarily within the message as a whole) 0-5 <AnnotationText> The text of the annotation 6 <PriceAmount> The amount of a price as a decimal number <CurrencyCode> An ISO currency code if the price amount is not in a default currency specified in the message header 8 <ChargeUnit> An ONIX controlled value specifying a unit of content or activity to which a price applies, eg page, article 0-1 iso:usd Required if not the default, or if no default was specified 1 ifrro:articlecopy ifrro:pagecopy Copyright EDItEUR & IFRRO 15

16 9 <PriceQuantity> A composite that specifies a quantity attribute of a price, eg an extent limit permitted for the stated price 10 <PriceQuantityType> An ONIX controlled value specifying a type of a quantity 11 <PriceQuantityDetail> A composite that carries details of a quantity 1-n Composite Not used 12 <Proximity> An ONIX controlled value specifying a relationship between a quantity and the <Value> stated in the composite, eg is less than, is not more than ; default is exactly 0-13 <Value> A decimal numeric value 14 <MeasureUnit> An ONIX controlled value specifying a unit of measure 15 <ReferenceUnit> An ONIX controlled value specifying a unit to which a quantity refers, if this is not implied by the <PriceQuantityType> 16 <VolumeDiscount> An ONIX controlled value specifying an applicable volume discount or discount class that is standard in a particular context: <VolumeDiscount> and <VolumeDiscount Detail> are mutually exclusive in any instance of <PriceDefinition> 17 <VolumeDiscountDetail> A composite that specifies a volume discount set by an individual rights controller 18 <VolumeUnit> An ONIX controlled value specifying a unit of volume, eg copies 19 <MinimumVolume> The minimum volume required to qualify for a specified volume discount: integer 20 <MaximumVolume> The maximum volume qualifying for a specified volume discount: integer 21 <PercentageDiscount> A discount expressed as a percentage of the <PriceAmount>: either <PercentageDiscount> or <DiscountedPriceAmount> must be present in any instance of <VolumeDiscountDetail>: decimal number less than <DiscountedPriceAmount> A discounted price expressed as an absolute amount per unit, in the currency of the <PriceAmount> above ukrro:cladefault If default discounts apply 0-n Composite If publisher-set discounts apply: each instance of the composite defines a discount rate band. Not used at present Copyright EDItEUR & IFRRO 16

17 Example 1: Use Case 3.1, change terms This example shows a simple case of a change terms notification from PLS to CLA, specifying new prices and licence inclusions/exclusions applying to a single book title and a single journal title. Repertoire Notification Type Delegator Delegate Mandating Publisher (PRC) Mandate ID Changed terms - 1 Changed terms - 2 ChangeTerms PLS: not explicitly expressed, on the basis that by default the Delegator is assumed to be the sender of the message CLA: not explicitly expressed, on the basis that by default the Delegate is assumed to be the addressee of the message QQQ M5678 Book: ISBN , title For Love and Money : include in all licences with new per-page prices where applicable Journal: ISSN , title Journal of Irreproducible Results : include in all licences except BL Doc Del with new per-article prices where applicable Example 1 1 <RepertoireNotification> 2 <NotificationType>ifrro:ChangeTerms</NotificationType> 3 <ReasonForNotification>ifrro:MandatorRequest</ReasonForNotification> 4 <NotificationID>57633/003</NotificationID> 5 <NotificationEffectiveDate> </NotificationEffectiveDate> 6 <RepertoireIdentifier> 7 <RepertoireIDType>ukrro:PLSRepertoireID</RepertoireIDType> 8 <IDValue>PLS </IDValue> 9 </RepertoireIdentifier> 10 <RepertoireDescription>???????</RepertoireDescription> 11 <RepertoireRelatedAgent> 12 <RepertoireAgentRelator>ukrro:HasMandatingPRC</RepertoireAgentRelator> 13 <AgentIdentifier> 14 <AgentIDType>ukrro:PLSCLANameID</AgentIDType> 15 <IDValue>PLS </IDValue> 16 </AgentIdentifier> 17 <Name>QQQ</Name> Name of mandating PRC 18 </RepertoireRelatedAgent> Copyright EDItEUR & IFRRO 17

18 19 <RepertoireRelatedMandate> 20 <RepertoireMandateRelator>ifrro:HasMandate</RepertoireMandateRelator> 21 <MandateIdentifier> 22 <MandateIDType>ukrro:PLSMandateID</MandateIDType> 23 <IDValue>M5678</IDValue> 24 </MandateIdentifier> 25 </RepertoireRelatedMandate> 26 <Definitions> 27 <PriceDefinition> 28 <PriceLabel>PriceA</PriceLabel> 29 <PriceAmount>2.50</PriceAmount> 30 <CurrencyCode>iso:GBP</CurrencyCode> 31 <ChargeUnit>ifrro:PageCopy</ChargeUnit> 32 </PriceDefinition> 33 <PriceDefinition> 34 <PriceLabel>PriceB</PriceLabel> 35 <PriceAmount>4.75</PriceAmount> 36 <CurrencyCode>iso:USD</CurrencyCode> 37 <ChargeUnit>ifrro:PageCopy</ChargeUnit> 38 </PriceDefinition> 39 <PriceDefinition> 40 <PriceLabel>PriceC</PriceLabel> 41 <PriceAmount>10.00</PriceAmount> 42 <CurrencyCode>iso:GBP</CurrencyCode> 43 <ChargeUnit>ifrro:ArticleCopy</ChargeUnit> 44 </PriceDefinition> 45 <PriceDefinition> 46 <PriceLabel>PriceD</PriceLabel> 47 <PriceAmount>17.50</PriceAmount> 48 <CurrencyCode>iso:USD</CurrencyCode> 49 <ChargeUnit>ifrro:ArticleCopy</ChargeUnit> 50 </PriceDefinition> 51 </Definitions> Copyright EDItEUR & IFRRO 18

19 52 <RepertoireDetail> This RepertoireDetail element is for ISBN <DelegatedRightByLicense> This group covers licences for which the PRC cannot set prices 54 <IncludeUnderLicense> 55 <LicenseType>ukrro:PLSCLACore</LicenseType> Include under all licences agreed between PLS and CLA as core to PLS mandating publishers 56 </IncludeUnderLicense> 57 <IncludeUnderLicense> Placeholder for enumeration of all CLA optional licences except those 58 <LicenseType>..</LicenseType> listed below 59 </IncludeUnderLicense> 60 <SubjectToPayment>ukrro:CLADefault</SubjectToPayment> CLA default prices 61 </DelegatedRightByLicense> 62 <DelegatedRightByLicense> This group covers UK licences for which the PRC can set prices 63 <IncludeUnderLicense> 64 <LicenseType>ukrro:CLAHighVolDocDel</LicenseType> 65 </IncludeUnderLicense> 66 <IncludeUnderLicense> 67 <LicenseType>ukrro:CLABLDS</LicenseType> 68 </IncludeUnderLicense> 69 <SubjectToPayment>PriceA</SubjectToPayment> Price specified in PriceDefinition as PriceA 70 </DelegatedRightByLicense> 71 <DelegatedRightByLicense> This group covers US licences for which the PRC can set prices 72 <IncludeUnderLicense> 73 <LicenseType>ukrro:CCCAPS</LicenseType> 74 </IncludeUnderLicense> 75 <IncludeUnderLicense> 76 <LicenseType>ukrro:CCCTRS</LicenseType> 77 </IncludeUnderLicense> 78 <SubjectToPayment>PriceB</SubjectToPayment> Price specified in PriceDefinition as PriceB 79 </DelegatedRightByLicense> 80 <DetailByResource> 81 <ResourceIdentifier> 82 <ResourceIDType>ifrro:ISBN13</ResourceIDType> 83 <IDValue> </IDValue> 84 </ResourceIdentifier> Copyright EDItEUR & IFRRO 19

20 85 <ResourceTitle> 86 <TitleText>For Love and Money</TitleText> 87 </ResourceTitle> 88 </DetailByResource> 89 </RepertoireDetail> 90 <RepertoireDetail> This RepertoireDetail element is for ISSN <DelegatedRightByLicense> 92 <IncludeUnderLicense> 93 <LicenseType>ukrro:PLSCLACore</LicenseType> Include under all licences agreed between PLS and CLA as core to PLS mandating publishers 94 </IncludeUnderLicense> 95 <IncludeUnderLicense> Placeholder for enumeration of all CLA optional licences except those 96 <LicenseType>..</LicenseType> listed below 97 </IncludeUnderLicense> 98 <SubjectToPayment>ukrro:CLADefault</SubjectToPayment> CLA default prices 99 </DelegatedRightByLicense> 100 <DelegatedRightByLicense> This group covers UK licences for which the PRC can set prices 101 <IncludeUnderLicense> 102 <LicenseType>ukrro:CLAHighVolDocDel</LicenseType> 103 </IncludeUnderLicense> 104 <SubjectToPayment>PriceC</SubjectToPayment> Price specified in PriceDefinition as PriceC 105 </DelegatedRightByLicense> 106 <DelegatedRightByLicense> 107 <ExcludeFromLicense> 108 <LicenseType>ukrro:CLABLDS</LicenseType> Exclude from BL licence 109 </ExcludeFromLicense> 110 </DelegatedRightByLicense> 111 <DelegatedRightByLicense> This group covers US licences for which the PRC can set prices 112 <IncludeUnderLicense> 113 <LicenseType>ukrro:CCCAPS</LicenseType> 114 </IncludeUnderLicense> 115 <IncludeUnderLicense> 116 <LicenseType>ukrro:CCCTRS</LicenseType> 117 </IncludeUnderLicense> Copyright EDItEUR & IFRRO 20

21 118 <SubjectToPayment>PriceD</SubjectToPayment> Price specified in PriceDefinition as PriceD 119 </DelegatedRightByLicense> 120 <DetailByResource> 121 <ResourceIdentifier> 122 <ResourceIDType>ifrro:ISSN</ResourceIDType> 123 <IDValue> </IDValue> 124 </ResourceIdentifier> 125 <ResourceTitle> 126 <TitleText>Journal of Irreproducible Results</TitleText> 127 </ResourceTitle> 128 </DetailByResource> 129 </RepertoireDetail> 130 </RepertoireNotification> Copyright EDItEUR & IFRRO 21

22 Example 2: Use Case 3.2, exclude title from all licences This example shows how a single title exclusion requested by a mandating PRC is communicated from PLS to CLA as a change terms notification. Repertoire Notification Type Delegator Delegate Mandating Publisher Mandate ID Title excluded ChangeTerms PLS: not explicitly expressed, on the basis that by default the Delegator is assumed to be the sender of the message CLA: not explicitly expressed, on the basis that by default the Delegate is assumed to be the addressee of the message Publisher BBB M2345 Book: ISBN , title: This Title s Not For Copying Example 2 1 <RepertoireNotification> 2 <RepertoireNotificationType>ifrro:ChangeTerms</RepertoireNotificationType> 3 <ReasonForNotification>ifrro:MandatorRequest</ReasonForNotification> 4 <RepertoireNotificationID>57633/004</RepertoireNotificationID> 5 <RepertoireNotificationEffectiveDate> </RepertoireNotificationEffectiveDate> 6 <RepertoireIdentifier> 7 <RepertoireIDType>ukrro:PLSRepertoireID</RepertoireIDType> 8 <IDValue>PLS </IDValue> 9 </RepertoireIdentifier> 10 <RepertoireDescription>???????</RepertoireDescription> 11 <RepertoireRelatedAgent> 12 <RepertoireAgentRelator>ukrro:HasMandatingPRC</RepertoireAgentRelator> 13 <AgentIdentifier> 14 <AgentIDType>ukrro:PLSCLANameID</AgentIDType> 15 <IDValue>PLS </IDValue> 16 </AgentIdentifier> 17 <Name>BBB</Name> 18 </RepertoireRelatedAgent> 19 <RepertoireRelatedMandate> 20 <RepertoireMandateRelator>ifrro:HasMandate</RepertoireMandateRelator> Copyright EDItEUR & IFRRO 22

23 21 <MandateIdentifier> 22 <MandateIDType>ukrro:PLSMandateID</MandateIDType> 23 <IDValue>M2345</IDValue> 24 </MandateIdentifier> 25 </RepertoireRelatedMandate> 26 <RepertoireDetail> 27 <DelegatedRightByLicense> 28 <ExcludeFromLicense> 29 <LicenseType>ukrro:AllCLAAdministeredLicenses</LicenseType> All licences operated by CLA, or CLA partners under bilateral agreements 30 </ExcludeFromLicense> 31 </DelegatedRightByLicense> 32 <DetailByResource> 33 <ResourceIdentifier> 34 <ResourceIDType>ifrro:ISBN13</ResourceIDType> 35 <IDValue> </IDValue> 36 </ResourceIdentifier> 37 <ResourceTitle> 38 <TitleText>This Title s Not For Copying</TitleText> 39 </ResourceTitle> 40 </DetailByResource> 41 </RepertoireDetail> 42 <RepertoireNotification> Copyright EDItEUR & IFRRO 23

24 Example 3: Use Case 3.3, exclude non-mandating PRC s repertoire from all licences This example shows how a request from a non-mandating PRC to have its entire repertoire excluded from all licences is communicated from PLS to CLA as a change terms notification. Repertoire Notification Type Delegator Delegate Non-mandating Publisher Mandate ID Title excluded ChangeTerms PLS: not explicitly expressed, on the basis that by default the Delegator is assumed to be the sender of the message CLA: not explicitly expressed, on the basis that by default the Delegate is assumed to be the addressee of the message Publisher XXX Not applicable Whole repertoire Example 3 1 <RepertoireNotification> 2 <RepertoireNotificationType>ifrro:ChangeTerms</RepertoireNotificationType> 3 <ReasonForNotification>ifrro:NonMandatorRequest</ReasonForNotification> 4 <RepertoireNotificationID>57633/004</RepertoireNotificationID> 5 <RepertoireNotificationEffectiveDate> </RepertoireNotificationEffectiveDate> 6 <RepertoireIdentifier> 7 <RepertoireIDType>ukrro:PLSRepertoireID</RepertoireIDType> 8 <IDValue>PLS </IDValue> 9 </RepertoireIdentifier> 10 <RepertoireDescription>???????</RepertoireDescription> 11 <RepertoireRelatedAgent> 12 <RepertoireAgentRelator>ukrro:HasNonMandatingPRC</RepertoireAgentRelator> 13 <AgentIdentifier> 14 <AgentIDType>ukrro:PLSCLANameID</AgentIDType> 15 <IDValue>PLS </IDValue> 16 </AgentIdentifier> 17 <Name>XXX</Name> 18 </RepertoireRelatedAgent> 19 <RepertoireDetail> 20 <DelegatedRightByLicense> Copyright EDItEUR & IFRRO 24

25 21 <ExcludeFromLicense> 22 <LicenseType>ukrro:AllCLAAdministeredLicenses</LicenseType> All licences operated by CLA, or CLA partners under bilateral agreements 23 </ExcludeFromLicense> 24 </DelegatedRightByLicense> 25 <WholeRepertoireExceptAsSpecified/> Exclusions apply to whole repertoire, since no exceptions are listed 26 </RepertoireDetail> 27 <RepertoireNotification> Copyright EDItEUR & IFRRO 25