Help

Icon - KMLM List KMLM List

View email archives for the history of this mailing list.

List Home All Archives Dates Threads Authors Subjects
sushidevelopers - Re: [sushidevelopers] COUNTER FAQs.doc Message Thread: Previous | Next
  • To: Oliver Pesch <OPesch@xxxxxxxxxxxxx>
  • From: Marco van Schagen <marco@xxxxxxxxxxxxxxxxxx>
  • Date: Tue, 21 Apr 2009 20:42:57 +0200
  • Cc: sushidevelopers@xxxxxxxxxxxxx
Send Email to sushidevelopers@list.niso.org:
Send new message
Reply to this message
Hi Oliver,Some suggestions:

In our project building our Sushi service we have created a simple page that
allows you to define the full Soap message. In doing so we have learnt a
great deal about the message format and about the actual working of the
communications. Having the Sushi request available in its purest Soap format
shows all you need to know about the actual request and the contents of the
fields.
I would like to see a sample request with fields filled with real-life-like
sample data. It would be especially interesting to see how various vendors
implemented the field for CustomerReference.id as this field would currently
allow a concatenation of various fields specifying customer identification
to allow data selection for reporting. (I have added a sample below.)

In reporting a problem with counter reports, I would suggest to include the
complete original Soap message.

I understand we need to output usage data, grouped per journal, for each
month within the date range. If available we need to output ft_totals,
ft_html, ft_pdf for each individual month. Please present us a sample. (I
have added a sample below.)

The usage data we need to output for Sushi is somewhat different from the
screenshots provided by Counter. Besides presenting the output as XML I'd
like to present the data formatted in a table, e.g. in HTML to allow our end
user to cross check the numbers. The table column names would match names
found in the XML. Do you have a sample?

As a vendor, I have data available per month, not per day. Any request will
be honoured with full month's data. So in the result we return we decided to
issue a warning and correct the begin and end dates where needed. Data is
included for those corrected begin and end dates. Would this be okay?

Hope this helps,
Marco

-------------------------------------
<?xml version="1.0" encoding="UTF-8"?> <soapenv:Envelope xmlns:soapenv="
http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd=";
http://www.w3.org/2001/XMLSchema" xmlns:xsi=";
http://www.w3.org/2001/XMLSchema-instance";> <soapenv:Body> <ReportRequest
ID="na_some_id_by_requestor" Created="2000-01-01T01:32:15.156Z" xmlns="
http://www.niso.org/schemas/sushi/counter";> <ns2:Requestor xmlns:ns2="
http://www.niso.org/schemas/sushi";> <ns2:ID>MY-INTEGRATOR-CODE harvestor
code as agreed between customer and vendor</ns2:ID> <ns2:Name>harvestor
name, informative or possibly for access validatio</ns2:Name>
<ns2:Email>email_for_support_contact_for_harvesting_issues@xxxxxxxxxxxxxx</ns2:Email>
</ns2:Requestor> <ns3:CustomerReference xmlns:ns3="
http://www.niso.org/schemas/sushi";> <ns3:ID>MyPlatform/ABC000000123 the
customer account and/or additional customer data to identify usage data to
be reported</ns3:ID> <ns3:Name>customer name, informative or possibly for
access validation</ns3:Name> </ns3:CustomerReference> <ns4:ReportDefinition
Name="JR1" Release="3.0" xmlns:ns4="http://www.niso.org/schemas/sushi";>
<ns4:Filters>
<ns4:UsageDateRange><ns4:Begin>2006-12-01</ns4:Begin><ns4:End>2006-12-02</ns4:End></ns4:UsageDateRange>
</ns4:Filters> </ns4:ReportDefinition> </ReportRequest> </soapenv:Body>
</soapenv:Envelope>

---------------------------------------

<Report>
  <ns5:Report ID="myplatform.com_Journal_Report_1_(R3)"
Created="2009-04-21T18:19:41.000Z" Name="TheVendor" Title="SUSHI-JR1"
Version="3.0" xmlns:ns5="http://www.niso.org/schemas/counter";>
    <ns5:Vendor>
      <ns5:Name>The Vendor name</ns5:Name>
      <ns5:ID>vendor chosen ID</ns5:ID>
      <ns5:Contact><ns5:Contact>Your contact</ns5:Contact>
      <ns5:E-mail>me@xxxxxxxxxxxx</ns5:E-mail></ns5:Contact>
      <ns5:WebSiteUrl>http://myvendor.com</ns5:WebSiteUrl>
      <ns5:LogoUrl>http://myvendor.com/pic/logo.png</ns5:LogoUrl>
    </ns5:Vendor>
    <ns5:Customer>
      <ns5:Name>Demonstration Account</ns5:Name>
      <ns5:ID>ABC000123</ns5:ID>
      <ns5:ReportItems>
        <ns5:ItemIdentifier>
          <ns5:Type>Print_ISSN</ns5:Type>
          <ns5:Value>1093-9253</ns5:Value>
        </ns5:ItemIdentifier>
        <ns5:ItemPlatform>myplatform</ns5:ItemPlatform>
        <ns5:ItemPublisher>mypublisher</ns5:ItemPublisher>
        <ns5:ItemName>My News</ns5:ItemName>
        <ns5:ItemDataType>Journal</ns5:ItemDataType>

        <ns5:ItemPerformance PubYr="0">
          <ns5:Period>
            <ns5:Begin>2006-12-01</ns5:Begin>
            <ns5:End>2006-12-31</ns5:End>
          </ns5:Period>
          <ns5:Category>Request</ns5:Category>
          <ns5:Instance>
            <ns5:MetricType>ft_html</ns5:MetricType>
            <ns5:Count>0.0</ns5:Count>
          </ns5:Instance>
          <ns5:Instance>
            <ns5:MetricType>ft_pdf</ns5:MetricType>
            <ns5:Count>0.0</ns5:Count>
          </ns5:Instance>
          <ns5:Instance>
            <ns5:MetricType>ft_total</ns5:MetricType>
            <ns5:Count>0.0</ns5:Count>
          </ns5:Instance>
        </ns5:ItemPerformance>

        <ns5:ItemPerformance PubYr="0">
          <ns5:Period>
            <ns5:Begin>2007-01-01</ns5:Begin>
            <ns5:End>2007-01-31</ns5:End>
          </ns5:Period>
          <ns5:Category>Request</ns5:Category>
          <ns5:Instance>
            <ns5:MetricType>ft_html</ns5:MetricType>
            <ns5:Count>0.0</ns5:Count>
          </ns5:Instance>
          <ns5:Instance>
            <ns5:MetricType>ft_pdf</ns5:MetricType>
            <ns5:Count>0.0</ns5:Count>
          </ns5:Instance>
          <ns5:Instance>
            <ns5:MetricType>ft_total</ns5:MetricType>
            <ns5:Count>0.0</ns5:Count>
          </ns5:Instance>
        </ns5:ItemPerformance>

      </ns5:ReportItems>
      <ns5:ReportItems>...</ns5:ReportItems>
      <ns5:ReportItems>...</ns5:ReportItems>
    </ns5:Customer>
  </ns5:Report>
</Report>
------------------------------------------

On Tue, Apr 21, 2009 at 7:24 PM, Oliver Pesch <OPesch@xxxxxxxxxxxxx> wrote:

>  As mentioned in a previous email, we are currently working on
> documentation for COUNTER reports.  However, given the recent discussion on
> COUNTER XML on this list, I thought it might be useful to get something out
> sooner than later.  Here is a draft of the FAQs -- this is a work in
> progress so please forward any additional questions, or if you have comments
> or concerns about the answers, please let me know so we can get things
> clear.
>
> Thanks
> Oliver
>
> CONFIDENTIALITY NOTICE
>
> This email and any files transmitted with it are confidential
> and solely for the use of the intended recipient. It may contain
> information which is covered by professional or other privilege.
> If you are neither the intended recipient of this email nor the
> person responsible for delivering it to the intended recipient,
> be advised that you have received this email in error and that
> any use of it is strictly prohibited. Please notify the sender
> immediately by reply email and then delete it from your system.
> EBSCO accepts no liability for any loss or damage suffered by
> any person arising from the use of this email.
>
> Please consider the environment before printing this email.
>
>
>

By Date: Previous | Next Current Thread By Thread: Previous | Next


  Mail converted by the most-excellent MHonArc 2.6.16