Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

KE is a co-operative effort between JISC, SURF, DEFF and DFG. International interoperability guidelines for the comparable exchange of usage data is one of these co-operative efforts.

Section
Column
width50%

Table of contents

Table of Contents
maxLevel3
Column
width50%
Wiki Markup

h1. Document information

| *Title:* KE Usage Statistics Guidelines \\
*Subject:* Usage Statistics,  Guidelines, Repositories, Publications, Research Intelligence \\
*Moderator:* Peter Verhaar ([KE Usage Statistics Work Group|standards:KE Usage Statistics Guidelines Work group]) \\
*Version:* 0.9.5 \\
*Date published:* 2010-05-18 \\
*Excerpt*: {excerpt}Guidelines for the exchange of usage statistics from a repository to a central server using OAI-PMH and OpenURL Context Objects.{excerpt}
\\  \\
(Optional information) \\
*Type:* Guidelines, [info:eu-repo/semantics/technicalDocumentation |http://purl.org/info:eu-repo/semantics/technicalDocumentation]\\
*Format:* html/text \\
*Identifier:* [http://purl.org/REP/standards/KE Usage Statistics Guidelines] \\
*Language:* EN \\
*Rights:* CC-BY \\
*Tags:*{page-info:labels}\\ |

...

A distinction will be made between the core set and extensions. Data in the core set can be recorded using standard elements or attributes that are defined in the OpenURL Context Object schema. The extensions are created to record aspects of usage events which cannot be captured using the official schema. They have usually been defined in the context of individual projects to meet very specific demands. Nevertheless, some of the extensions may be relevant for other projects as well. They are included here to inform the usage statistics community what additional information could be made available. Naturally, the implementation of all the extension elements are optional.

Warningnote

There are also other profiles we coud incorporate the best practices from

see http://alcme.oclc.org/openurl/docs/pdf/SanAntonioProfile.pdf

...

Description

An identification of a specific usage event.

XPath

ctx:context-object/@identifier

Usage

Optional

Format

No requirements are given for the format of the identifier. If this optional identifier is used, it must be (1) opaque and (2) unique for a specific usage event.
In the Netherlands a MD5 Hash is made from the concatenated string combining the code of the institution, identifier of the publication and the timestamp.
Other projects use different ways to create an identifier, as long as it is globally unique.

Example

b06c0444f37249a0a8f748d3b823ef2a


Warningnote

This must be mandatory, at least to identify the repository. This can be done for example to use the repository name as a prefix prior to the opaque identifier. This could be categorised as provenance information. - jochen Jochen

Note

Usage events are good to use as a control mechanism for the aggregation database to check if duplicate events are harvested. The provenance information of the repository can be found in the <resolver> element, see section 4.1.6. - Peter

...

Element name

minOccurs

maxOccurs

Referent

1

1

ReferringEntity

0

1

Requester

1

1

ServiceType

1

1

Resolver

1

1

Referrer

0

1

Warningnote

Just a note: If we make this schema more restrictive, we diverge from the original schema. - Jochen

...

Description

The referrer may be categorised on the basis of a limited list of known referrers. All permitted values will be registered in the OpenURL registry.

Warningnote

What worries me that I don't see such a list there. Should this not state: "A referrer name must be uniquely identifier using a Source Identifier (info:sid). Concatenating the info:sid namespace with the internet domain name, subdomain name or host name. "Question: When such list exists, must the application check this string with this list? - mauriceMaurice


XPath

ctx:referring-entity/ctx:identifier

Usage

Optional

Format

A URI that is registered in http://info-uri.info/registry/OAIHandler?verb=GetRecord&metadataPrefix=reg&identifier=info:sid/

Example

info:sid/google

Warningnote

Peter, the info:sid documentation tells us that this name may refer to an Internet domain name, subdomain name, or host name. The examples at indo-uri.info show

  • info:sid/amazon.co.uk
  • info:sid/oclc.org
  • info:sid/amazon.co.uk:books
  • info:sid/oclc.org:inspec
    Should the example used above not also be info:sid/google.com ?
    I am unfamiliar on this terrain, maybe I am wrong and info:sid/google is allowed.
    I don't know what is in a apache logfile that can be easily used to transform in an info:sid. Should a real example not be reflecting something like info:sid/www.google.nl/search?q="Who+controls+the+internet" ? (in other words, how intelligent do implementers need to make their software for creating a info:sid ?)
  • or should this be stripped down to info:sid/www.google.nl
  • or even without the subdomain www info:sid/google.nl
  • or must the top domain be changed to .com info:sid/google.com
  • or indeed only the domain name, without the top-domain info:sid/google
  • or only the host info:sid/www
    I know I am just out of my league here, but maybe other people who implement these guidelines have similar questions in the future.
    Maybe Benoit knows more about this.
    All the best,
    -- Maurice

4.1.4. <requester>

...

Code Block
xml
xml
linenumbertrue
titlemethod 2 : each Context Object in separate OAI-PMH records : OAI-PMH listRecords metadataPrefix=ctxo
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<OAI-PMH>
...
<record>
    <header>
        <identifier>urn:uuid:fd23522e-c447-4801-9be4-c93c60a2d550 </identifier>
        <datestamp>2009-06-02T14:10:02Z</datestamp>
    </header>
    <metadata>
        <context-object xmlns="info:ofi/fmt:xml:xsd:ctx" datestamp="2009-06-01T19:20:57Z">
          ...
        </context-object>
    </metadata>
</record>
<record>
    <header>
        <identifier>urn:uuid:1ad69103-6bd0-4a90-ae75-e4b644c136a6 </identifier>
        <datestamp>2009-06-02T14:10:04Z</datestamp>
    </header>
    <metadata>
        <context-object xmlns="info:ofi/fmt:xml:xsd:ctx" datestamp="2009-06-01T19:21:07Z">
          ...
        </context-object>
    </metadata>
</record>
...
</OAI-PMH>
Warningnote

As KE expert group, do we have a recommendation for one of the two methods?

...


Infonote

To be done: find a web location; create a "cool" URI, implement the above mechanism

...