Child pages
  • KE Usage Statistics Guidelines

Versions Compared

Key

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

...

Element name

minOccurs

maxOccurs

Referent

1

1

ReferringEntity

0

1

Requester

1

1

ServiceType

1

1

Resolver

1

1

Referrer

0

1

 


4.1.2. <referent>

The <referent> element must provide information on the document that is requested. More specifically, it must record the following data elements.

...

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.

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

 

...

.com



4.1.4. <requester>

The user who has sent the request for the file is identified in the <requester> element.

...

<requester/identifier> | IP-address of requester

Description

The user can be identified by providing the IP-address. Including the full IP-address in the description of a usage event is not permitted by international privacy laws. For this reason, the IP-address needs to be obfuscated. The IP-address must be hashed using salted MD5 encryption. MD5 encryption of IP addresses can easily be hacked. The question if such MD5 encryption secures the privacy sufficiently warrant further research by legal advisors. The The salt must minimally consist of 12 characters. The IP address of the requester is pseudonymised using encryptions, before it is exchanged and taken outside the web-server to another location. Therefore individual users can be recognised when aggregated from distributed repositories, but they cannot be referred back to be identified a 'natural person'. This method may seem consisted with method appears to be consistent with the European Act for Protection of Personal data. The summary can be found here: ? http://europa.eu/legislation_summaries/information_society/l14012_en.htm

Image Removed

. Further legal research needs to be done if is needed to determine of if this method is sufficient to protect the personal data of a 'natural person', in order to operate within the boundaries of the law.

XPath

ctx:context-object/ctx:requester/ctx:identifier

Usage

Mandatory

Format

A data-URI, consisting of the prefix "data:,", followed by a 32-digit hexadecimal number.

Example

data:,c06f0464f37249a0a9f848d4b823ef2a

 

 

...

<requester/.../dcterms:spatial> | Geographic location

ctx:context-object/ctx:requester/ctx:identifier
If the C-Class subnet is hashed, the MD5 hash must be provided in the following element:
ctx:context-object/ctx:metadata/dini:requesterinfo/dini:hashed-c
If this element is used, the <metadata> element must be preceded by
ctx:requester/ctx:metadata-by-al/ctx:format
with value
"http://dini.de/namespace/oas-requesterinfo"

Description

When the IP-address is obfuscated, this will have the disadvantage that information on the geographic location, for instance, can no longer be derived. For this reason, the C-Class subnet must be provided. The C-Class subnet, which consists of the three most significant bytes from the IP-address, is used to designate the network ID. The final (most significant) byte, which designates the HOST ID, is replaced with a '0'. The C-class Subnet may optionally be hashed using MD5 encryption.

XPath

Usage

Optional

Format

A data-URI, consisting of the prefix "data:,", followed either by a 32-digit hexadecimal number, or by three hexadecimal numbers separated by a dot, followed by a dot and a '0'.

Examples

data:,118.94.150.0
data:,ec17f0564f32240c0a9d848d4b823ef2a

<requester/.../dcterms:spatial> | Geographic location

Description

The country from which the request originated may also be provided explicitly.

XPath

ctx:context-object/ctx:requester/ The country from which the request originated may also be provided explicitly.

XPath

ctx:context-object/ctx:requester/ctx:metadata-by-val/ctx:metadata/dcterms:spatial

If this element is used, the <metadata> element must be preceded by
ctx:requester/ctx:metadata-by-val/ctx:format
with value
"http://dublincore.org/documents/2008/01/14/dcmi-terms/"

Usage

Optional

Format

A two-letter code in lower case, following the ISO 3166-1-alpha-2 standard. http://www.iso.org/iso/english_country_names_and_code_elements

Example

ne

...

<service-type/.../dcterms:type> | Request Type

Description

The request type specifies if the request is for type provides information on the type of user action. Currently, this element is only used to distinguish between a download of an object file or and a metadata record view. In the future, extensions can be defined for other kinds of user actions, such as downloads of datasets, or ratings.

XPath

ctx:context-object/ctx:service-type/ctx:metadata-by-val/ctx:metadata/dcterms:type

If this element is used, the <metadata> element must be preceded by

ctx:requester/ctx:metadata-by-val/ctx:format

with value

"http://dublincore.org/documents/2008/01/14/dcmi-terms/"

Inclusion

Mandatory

Format

Host name

 

Description

One of these values must be used:

  • info:eu-repo/semantics/objectFile or
  • info:eu-repo/semantics/descriptiveMetadata
    See for explanation of these concepts info:eu-repo Object types

Example

info:eu-repo/semantics/objectFile

Note

In the CORE set this is a mandatory field, that allows these two values. However, in the future, extensions can be made with optional other values from a controlled vocabulary, for example for datasets.

4.1.6. <resolver> and <referrer>

<resolver/identifier> | Host name

An identification of the institution that is responsible for the repository in which the requested document is storedbe used:

  • info:eu-repo/semantics/objectFile or
  • info:eu-repo/semantics/descriptiveMetadata See for explanation of these concepts info:eu-repo Object types

Example

info:eu-repo/semantics/objectFile

 

4.1.6. <resolver> and <referrer>

<resolver/identifier> | Host name

Host name

 

Description

An identification of the institution that is responsible for the repository in which the requested document is stored.

XPath

ctx:context-object/ctx:resolver/ctx:identifier

Usage

Mandatory

Format

The baseURL of the repository must be used. This must be a URI, and not only the domain name.

Example

http://www.worldcat.org/libraries/53238

<resolver/identifier> | Location of OpenURL Resolver

Description

In the case of link resolver usage data, the URL of the OpenURL resolver must be provided.

XPath

ctx:context-object/ctx:resolver/ctx:identifier

Usage

Optional

Format

A unique global identifier taken from the WorldCat registry of institutions, catalogues and OpenURL resolvers.

Example

http://www.worldcat.org/libraries/53238

<resolver/identifier> | Location of OpenURL Resolver

Description

In the case of link resolver usage data, the URL of the OpenURL resolver must be provided

URL

Example

http://sfx.gbv.de:9004/sfx_sub/

<referrer/identifier> | Link resolver Context Identifier

Description

The identifier of the context from within the user triggered the usage of the target resource.

XPath

ctx:context-object/ctx:referrer/ctx:identifier

Usage

Optional

Format

URL

Example

info:sid/dlib.org:dlib</identifier

4.2. Extensions

4.2.1. <requester>

<requested/identifier> | C-class Subnet

Description

When the IP-address is obfuscated, this will have the disadvantage that information on the geographic location, for instance, can no longer be derived. For this reason, the C-Class subnet must be provided. The C-Class subnet, which consists of the three most significant bytes from the IP-address, is used to designate the network ID. The final (most significant) byte, which designates the HOST ID, is replaced with a '0'. The C-class Subnet may optionally be hashed using MD5 encryption.

XPath

ctx:context-object/ctx:resolverrequester/ctx:identifier

Usage

Optional

Format

URL

Example

http://sfx.gbv.de:9004/sfx_sub/

<referrer/identifier> | Link resolver Context Identifier

Description

The identifier of the context from within the user triggered the usage of the target resource.

XPath

ctx:context-object/ctx:referrer/ctx:identifier If the C-Class subnet is hashed, the MD5 hash must be provided in the following element: ctx:context-object/ctx:metadata/dini:requesterinfo/dini:hashed-c If this element is used, the <metadata> element must be preceded by ctx:requester/ctx:metadata-by-al/ctx:format with value "http://dini.de/namespace/oas-requesterinfo"

Usage

Optional

Format

URL

Example

info:sid/dlib.org:dlib</identifier

4.2. Extensions

...

A data-URI, consisting of the prefix "data:,", followed either by a 32-digit hexadecimal number, or by three hexadecimal numbers separated by a dot, followed by a dot and a '0'.

Examples

data:,118.94.150.0 data:,ec17f0564f32240c0a9d848d4b823ef2a

<requester/.../dini:classification> | Classification of the requester

...