Section

Column

width	50%


h1. {anchor:Document information} Document information

| *Title:* KE Usage Statistics Guidelines \\
*Subject:* Usage Statistics,&nbsp; Guidelines, Repositories, Publications, Research Intelligence \\
*Moderator:* Peter Verhaar ([KE Usage Statistics Work Group|standards:KE Usage Statistics Guidelines Work group]) \\
*Version:* 0.2 \\
*Date published:* 2010-04-13 \\
*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, Technical Documentation \\
*Format:* html/text \\
*Identifier:* [http://purl.org/REP/standards/KE Usage Statistics Guidelines|http://purl.org/REP/standards/KE+Usage+Statistics+Guidelines]\\
*Language:* EN \\
*Rights:* CC-BY \\
*Tags:* {page-info:labels}Macro om labels te geven niet mogelijk in huidige installatie, wordt nog  geupdate |

...

Tip
We agreed to filter based on the robot name, with regular expressions

heuristics

A small note about behaviour analysis with heuristics:

...

This request will active a special tool that can inspect the server logging and that can return the requested data. These data are transferred as OpenURL Context Object log entries, as part of a SUSHI response.
The reponse must repeat all the information from the request, and provide the requested report as XML payload
The usage data are subsequently stored in a central database. External parties can obtain information about the contents of this central database through specially developed web services. The log harvester must ultimately expose these data in the form of COUNTER-compliant reports.
Listing 2 is an example of a SUSHI request, sent from the log aggregator to a repository.

Code Block

	xml
	xml
title	Listing 2
linenumbers	true
collapse	true

<?xml version="1.0" encoding="UTF-8"?>
 <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://schemas.xmlsoap.org/soap/envelope/ http://schemas.xmlsoap.org/soap/envelope/">
 <soap:Body>
  <ReportRequest xmlns:ctr="http://www.niso.org/schemas/sushi/counter"
   xsi:schemaLocation="http://www.niso.org/schemas/sushi/counter http://www.niso.org/schemas/sushi/counter_sushi3_0.xsd"
   xmlns="http://www.niso.org/schemas/sushi"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
   <Requestor>
    <ID>www.logaggregator.nl</ID>
    <Name>Log Aggregator</Name>
    <Email>logaggregator@surf.nl</Email>
   </Requestor>
   <CustomerReference>
    <ID>www.leiden.edu</ID>
    <Name>Leiden University</Name>
   </CustomerReference>
   <ReportDefinition Release="urn:robots-v1.xml" Name="Daily Report v1">
    <Filters>
     <UsageDateRange>
      <Begin>2009-12-21</Begin>
      <End>2009-12-22</End>
     </UsageDateRange>
    </Filters>
   </ReportDefinition>
  </ReportRequest>
 </soap:Body>
</soap:Envelope>

Listing 2.

Note that the intent of the SUSHI request above is to see all the usage events that have occurred on 21 December 2009. The SUSHI schema was originally developed for the exhchange of COUNTER-compliant reports. In the documentation of the SUSHI XML schema, it is explained that COUNTER usage is only reported at the month level. In SURE, only daily reports can be provided. Therefore, it will be assumed that the implied time on the date that is mentioned is 0:00. The request in the example that is given thus involves all the usage events that have occurred in between 2009-12-21T00:00:00 and 2002-12-22T00:00:00.
As explained previously, the repository can respond in four different ways. If the parameters of the request are valid, and if the requested report is available, the OpenURL ContextObjects will be sent immediately. The Open URL Context Objects will be wrapped into element <Report>, as can be seen in listing 3.

Code Block

	xml
	xml
title	Listing 3
linenumbers	true
collapse	true

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://schemas.xmlsoap.org/soap/envelope/ http://schemas.xmlsoap.org/soap/envelope/">
 <soap:Body>
  <ReportResponse xmlns:ctr="http://www.niso.org/schemas/sushi/counter"
   xsi:schemaLocation="http://www.niso.org/schemas/sushi/counter http://www.niso.org/schemas/sushi/counter_sushi3_0.xsd"
   xmlns="http://www.niso.org/schemas/sushi"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
   <Requestor>
    <ID>www.logaggregator.nl</ID>
    <Name>Log Aggregator</Name>
    <Email>logaggregator@surf.nl</Email>
   </Requestor>
   <CustomerReference>
    <ID>www.leiden.edu</ID>
    <Name>Leiden University</Name>
   </CustomerReference>
   <ReportDefinition Release="urn:DRv1" Name="Daily Report v1">
    <Filters>
     <UsageDateRange>
      <Begin>2009-12-22</Begin>
      <End>2009-12-23</End>
     </UsageDateRange>
    </Filters>
   </ReportDefinition>
   <Report>
    <ctx:context-objects xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns:dcterms="http://dublincore.org/documents/2008/01/14/dcmi-terms/"
     xmlns:ctx="info:ofi/fmt:xml:xsd:ctx">
     <ctx:context-object timestamp="2009-11- 09T05:56:18+01:00">
       ...
     </ctx:context-object>
    </ctx:context-objects>
   </Report>
  </ReportResponse>
 </soap:Body>
</soap:Envelope>

Listing 3.

If the begin date and the end date in the request of the log aggregator form a period that exceeds one day, an error message must be sent. In the SUSHI schema, such messages may be sent in an <Exception> element. Three types of errors can be distinguished. Each error type is given its own number. An human-readable error message is provided under <Message>.

Code Block

	xml
	xml
title	Listing 4
linenumbers	true
collapse	true

 <?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://schemas.xmlsoap.org/soap/envelope/ http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ReportResponse xmlns:ctr="http://www.niso.org/schemas/sushi/counter"
xsi:schemaLocation="http://www.niso.org/schemas/sushi/counter http://www.niso.org/schemas/sushi/counter_sushi3_0.xsd"
xmlns="http://www.niso.org/schemas/sushi"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
<Requestor>
<ID>www.logaggregator.nl</ID>
<Name>Log Aggregator</Name>
<Email>logaggregator@surf.nl</Email>
</Requestor>
<CustomerReference>
<ID>www.leiden.edu</ID>
<Name>Leiden University</Name>
</CustomerReference>
<ReportDefinition Release="urn:DRv1" Name="Daily Report v1">
<Filters>
<UsageDateRange>
<Begin>2009-12-22</Begin>
<End>2009-12-23</End>
</UsageDateRange>
</Filters>
</ReportDefinition>
<Exception>
<Number>1</Number>
<Message>The range of dates that was provided is not valid. Only daily reports are
available.</Message>
</Exception> </ReportResponse>
</soap:Body>
</soap:Envelope>

Listing 4.

A second type of error may be caused by the fact that the file that is mentioned in the request can not be accessed. In this situation, the response will look as follows:

Code Block

	xml
	xml
title	Listing 5
linenumbers	true
collapse	true

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://schemas.xmlsoap.org/soap/envelope/ http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ReportResponse xmlns:ctr="http://www.niso.org/schemas/sushi/counter"
xsi:schemaLocation="http://www.niso.org/schemas/sushi/counter http://www.niso.org/schemas/sushi/counter_sushi3_0.xsd"
xmlns="http://www.niso.org/schemas/sushi"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
<Requestor>
<ID>www.logaggregator.nl</ID>
<Name>Log Aggregator</Name>
<Email>logaggregator@surf.nl</Email>
</Requestor>
<CustomerReference>
<ID>www.leiden.edu</ID>
<Name>Leiden University</Name>
</CustomerReference>
<ReportDefinition Release="urn:DRv1" Name="Daily Report v1">
<Filters>
<UsageDateRange>
<Begin>2009-12-22</Begin>
<End>2009-12-23</End>
</UsageDateRange>
</Filters>
</ReportDefinition>
<Exception>
<Number>2</Number>
<Message>The file describing the internet robots is not accessible.</Message>
</Exception> </ReportResponse>
</soap:Body>
</soap:Envelope>

...

When the repository is in the course of producing the requested report, a response will be sent that is very similar to listing 6. The estimated time of completion will be provided in the <Data> element. According to the documentation of the SUSHI XML schema, this element may be used for any other optional data.

Code Block

	xml
	xml
title	Listing 6
linenumbers	true
collapse	true

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                xsi:schemaLocation="http://schemas.xmlsoap.org/soap/envelope/
                                      http://schemas.xmlsoap.org/soap/envelope/">
 <soap:Body>
   <ReportResponse xmlns:ctr="http://www.niso.org/schemas/sushi/counter"
                    xsi:schemaLocation="http://www.niso.org/schemas/sushi/counter
                                          http://www.niso.org/schemas/sushi/counter_sushi3_0.xsd"
                    xmlns="http://www.niso.org/schemas/sushi"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
    <Requestor>
     <ID>www.logaggregator.nl</ID>
     <Name>Log Aggregator</Name>
     <Email>logaggregator@surf.nl</Email>
    </Requestor>
    <CustomerReference>
     <ID>www.leiden.edu</ID>
     <Name>Leiden University</Name>
    </CustomerReference>
    <ReportDefinition Release="urn:DRv1" Name="Daily Report v1">
     <Filters>
      <UsageDateRange>
       <Begin>2009-12-22</Begin>
       <End>2009-12-23</End>
      </UsageDateRange>
     </Filters>
    </ReportDefinition>
    <Exception>
     <Number>3</Number>
     <Message>The report is not yet available. The estimated time of completion is
               provided under "Data".</Message>
     <Data>2010-01-08T12:13:00+01:00</Data>
    </Exception>
  </ReportResponse>
 </soap:Body>
</soap:Envelope>

...

error numbers

Error numbers and the corresponding Error messages are also provided in the table below.

...

Child pages

Versions Compared

Old Version 10

New Version 11

Key

Table of contents

heuristics

error numbers

Child pages

Page History

Versions Compared

Old Version 10

New Version 11

Key

Table of contents

heuristics

error numbers