1、ANSI/NISO Z39.93-2007ISSN: 1041-5653The Standardized Usage Statistics Harvesting Initiative (SUSHI) Protocol Abstract: This standard defines an automated request and response model for the harvesting of electronic resource usage data utilizing a Web services framework that can replace the user-media
2、ted collection of usage data reports. It was designed as a generalized protocol extensible to a variety of usage reports. An extension designed specifically to work with COUNTER reports is provided. The standard is built on SOAP (Simple Object Access Protocol) for transferring request and response m
3、essages. The GetReport method is used for transferring ReportRequest as the input message and returning ReportResponse as the output message. The standard includes a versioned Web Services Description Language (WSDL) to describe the Web service namespace and operations, and an XML schema constrainin
4、g the syntax of the SUSHI transaction. Rules for report naming are outlined and complemented by an external reports registry, which provides for the definition of both COUNTER and non-COUNTER reports. An American National Standard Developed by the National Information Standards Organization Approved
5、 October 29, 2007 by the American National Standards Institute Published by the National Information Standards Organization Baltimore, Maryland, U.S.A. ANSI/NISO Z39.93-2007 About NISO Standards NISO standards are developed by the Standards Working Groups of the National Information Standards Organi
6、zation. The development process is a strenuous one that includes a rigorous peer review of proposed standards open to each NISO Voting Member and any other interested party. Final approval of the standard involves verification by the American National Standards Institute that its requirements for du
7、e process, consensus, and other approval criteria have been met by NISO. Once verified and approved, NISO Standards also become American National Standards. These standards may be revised or withdrawn at any time. For current information on the status of this standard contact the NISO office or visi
8、t the NISO website at: http:/www.niso.org. Published by National Information Standards Organization (NISO ) One North Charles Street, Suite 1905 Baltimore, MD 21201 www.niso.org Copyright 2007 by the National Information Standards Organization All rights reserved under International and Pan-American
9、 Copyright Conventions. For noncommercial purposes only, this publication may be reproduced or transmitted in any form or by any means without prior permission in writing from the publisher, provided it is reproduced accurately, the source of the material is identified, and the NISO copyright status
10、 is acknowledged. All inquires regarding translations into other languages or commercial reproduction or distribution should be addressed to: NISO Press, One North Charles Street, Suite 1905, Baltimore, MD 21201. Printed in the United States of America ISSN: 1041-5653 (National Information standards
11、 series) ISBN (10): 1-880124-70-X ISBN (13): 978-1-880124-70-3 ANSI/NISO Z39.93-2007 2007 NISO i Contents Foreword iii 1 Purpose. 1 2 Scope. 1 3 References 1 4 Definitions. 2 5 Element Reference Guide 3 5.1 Element Listings 3 5.2 Data Types 3 6 SUSHI Protocol 4 6.1 Namespace 4 6.2 Data Contract. 5 6
12、.2.1 ReportRequest. 5 6.2.1.1 Requestor 6 6.2.1.2 CustomerReference 7 6.2.1.3 ReportDefinition.8 6.2.2 ReportResponse 9 6.2.3 Exceptions and Errors 11 6.3 Service Contract (WSDL) 14 6.3.1 Service Contract Definitions and Types. 14 6.3.2 Service Contract Operation 14 6.3.3 Service Contract Messages.
13、15 6.3.4 COUNTER-SUSHI Service Contract . 15 7 Report Naming 16 7.1 Types of Reports . 16 7.2 Report Naming Requirements. 16 7.3 Registry of Reports 16 8 Versions and Extensions 16 8.1 SUSHI Versioning 16 8.2 Extending Data Contract for Additional Reports 17 Appendix A (informative) SUSHI Protocol X
14、ML Schema 19 Appendix B (informative) Core SUSHI WSDL 22 Appendix C (informative) COUNTER-SUSHI Extension for COUNTER reports . 24 Appendix D (informative) Utilizing SUSHI to Harvest Additional Reports 25 Appendix E (informative) SUSHI Maintenance 26 ANSI/NISO Z39.93-2007 ii 2007 NISO Appendix F (in
15、formative) SUSHI Data Exchange Examples.27 Appendix G (informative) Security Considerations 30 Appendix H (informative) Creating Proprietary SUSHI Extensions.32 Bibliography 34 Tables Table 1: Description of Element Tables. 3 Table 2: Data Type Definitions. 3 Table 3: SUSHI Protocol Header . 4 Table
16、 4: SUSHI Protocol ReportRequest Schema 5 Table 5: Elements for ReportRequest 5 Table 6: SUSHI Protocol Requestor Schema 7 Table 7: Elements for Requestor . 7 Table 8: SUSHI Protocol CustomerReference Schema 7 Table 9: Elements for CustomerReference 8 Table 10: SUSHI Protocol ReportDefinition Schema
17、. 8 Table 11: Elements for ReportDefinition 9 Table 12: Elements for UsageDateRange . 9 Table 13: SUSHI Protocol ReportResponse Schema . 10 Table 14: Elements for ReportResponse. 11 Table 15: SUSHI Protocol Exception Reporting Schema 11 Table 16: Elements for Exception 12 Table 17: Standard SUSHI Ex
18、ceptions 13 Table 18: SUSHI Service Contract Definitions and Types. 14 Table 19: SUSHI Service Contract Operation 15 Table 20: SUSHI Service Contract Messages. 15 Table 21: COUNTER-SUSHI Service Contract Definitions and Types . 15 Table 22: Example of Extending SUSHI 33 Figures Figure 1: Diagram of
19、SUSHI ReportRequest. 6 Figure 2: Diagram of SUSHI ReportResponse 10 Figure 3: Diagram of SUSHI Exception Reporting. 12 Figure 4: Diagram of COUNTER-SUSHI Extension ReportRequest. 17 Figure 5: Diagram of COUNTER-SUSHI Extension ReportResponse 18 Figure 6: Diagram of “Extended” SUSHI Schema . 33 ANSI/
20、NISO Z39.93-2007 2007 NISO iii Foreword (This foreword is not part of ANSI / NISO Z39.93-2007, The Standardized Usage Statistics Harvesting Initiative (SUSHI) Protocol. It is included for information only.) About This Standard This standard was developed in response to the need in libraries to more
21、efficiently collect COUNTER (Counting Online Usage of NeTworked Electronic Resources) compliant usage statistics. COUNTER was launched in March 2002 as an international initiative to help librarians and publishers in the recording and exchange of usage statistics for electronic resources. By followi
22、ng COUNTERs Code of Practice, vendors can provide library customers with Excel or CSV (comma delimited) files of usage data using COUNTERs standardized formats and data elements. As of September 2006, COUNTER has nearly 200 members and over 40 vendors have certified compliance to one or more Code of
23、 Practice releases. COUNTER Usage Difficulties The success of COUNTER created a new problem for librariansthe amount of time they spend retrieving, storing, and aggregating their COUNTER reports. For each supplier of COUNTER reports, a library must manually connect to the suppliers website and downl
24、oad the Excel or CSV files. Once retrieval is complete, the librarian is presented with multiple data files from multiple providers, which, while standardized, still require significant manipulation and normalization of the data to aggregate reports. Many libraries are creating or purchasing electro
25、nic resource management (ERM) systems to help them in storing and managing all this data. But the process for transferring the Excel/CSV data into the repository is either manual or requires custom programming. Background on SUSHI Development The idea for an automated method to solve the COUNTER rep
26、ort problem was first discussed by Adam Chandler and Ted Fons at the 2004 Charleston Conference. Fons is Product Manager for the Innovative Interfaces Inc. (III) Electronic Resource Management module. Chandler is Coordinator, Service Design Group, Information Technology and Technical Services at Cor
27、nell University Library, and is active in the Digital Library Federations Electronic Resource Management Initiative (ERMI). The two agreed to push forward a Web service protocol for handling the XML version of the COUNTER reports. Tim Jewell (University of Washington) and Oliver Pesch (EBSCO) were r
28、ecruited at the American Library Association meeting in June 2005 to further refine the concept. A project team was formed and from there the project was expanded to include the members listed below. Draft requirements and specifications for the protocol began in July 2005. In October 2005, NISO agr
29、eed to sponsor the initiative, the group was officially named SUSHI (Standardized Usage Statistics Harvesting Initiative), and work began on creating this standard defining the protocol. The SUSHI Web Service The Standardized Usage Statistics Harvesting Initiative (SUSHI) represents a “Web services”
30、 approach to solving the COUNTER retrieval and consolidation problem. The protocol is a SOAP (Simple Object Access Protocol) request/response Web services “wrapper” for the XML version of COUNTER reports. In the protocol, a transaction begins when a client service running as part of an application d
31、eveloped by a libraryor running as part of a usage data consolidation service or ILS / ERM systemidentifies itself, identifies the customer whose statistics are being requested, and specifies the desired report to the SUSHI server service running at a data provider. In response, the server provides
32、the report in XML format, along with the requestor and customer informationor an appropriate error message. The SUSHI developers envision a system in which the client system is programmed to automatically retrieve reports on a monthly schedule for all the COUNTER-compliant vendors with which the lib
33、rary does business. The ability for the client to manually trigger requests may also be desirable to allow for easier testing with new SUSHI implementations and for retrieving previous months usage data. ANSI/NISO Z39.93-2007 iv 2007 NISO Although developed primarily for COUNTER reports, SUSHI was w
34、ritten as a generalized protocol that accommodates extensions for customized non-COUNTER usage reports. The COUNTER-specific schema extension is provided to accompany the general protocol. Trial Use The SUSHI protocol was issued as a Draft Standard for Trial Use from September 20, 2006 through May 2
35、0, 2007. During the trial period, dozens of implementations of both the client or server sides of the protocol were successfully conducted. Minor revisions to the schemas were made to address issues identified during the trial. The current standard reflects those changes. The schema version at the t
36、ime of the trial was 1.0; the schema version at the time of publication of this standard was 1.5. The most current version of the schema is maintained on the SUSHI schema website (http:/www.niso.org/schemas/sushi/). Trademarks, Service Marks Wherever used in this standard, all terms that are tradema
37、rks or service marks are and remain the property of their respective owners. NISO Voting Members At the time this standard was balloted, NISO had the following Voting Members: 3M Susan Boettcher, Roger D. Larson (Alt) Alcatel-Lucent Technologies M.E. Brennan American Association of Law Libraries Rob
38、ert L. Oakley, Mary Alice Baish (Alt) American Library Association Cindy Hepfer American Psychological Association Linda Beebe, Janice Fleming (Alt) American Society for Information Science and Technology (ASIS therefore, the XML formatted data can be collected in spreadsheets, in-house databases, c
39、ommercial electronic resource management (ERM) systems, or any other repository that the user establishes for that purpose. 3 References This standard references the following documents: The COUNTER Code of Practice for Journals and Databases. Edinburgh, UK: COUNTER. Release 2, published April 2005;
40、 valid from 1 January 2006. Available from: http:/www.projectcounter.org/code_practice.html The COUNTER Code of Practice for Books and Reference Works. Edinburgh, UK: COUNTER. Release 1, March 2006. Available from: http:/www.projectcounter.org/code_practice.html COUNTER Register of Vendors. http:/ww
41、w.projectcounter.org/articles.html The Unicode Consortium, The Unicode Standard, Version 5.0.0. Boston, MA, Addison-Wesley, 2007. ISBN 0-321-48091-0. Online version available from: http:/www.unicode.org/versions/Unicode5.0.0/ W3C Note-datetime, Date and Time Formats. http:/www.w3.org/TR/NOTE-datetim
42、e W3C Recommendation. Simple Object Access Protocol (SOAP), version 1.2. World Wide Web Consortium, June 24, 2003. Available from: http:/www.w3.org/TR/soap/ W3C Recommendation. Extensible Markup Language (XML), version 1.0 (Third Edition). World Wide Web Consortium, February 4, 2004. http:/www.w3.or
43、g/TR/2004/REC-xml-20040204/ ANSI/NISO Z39.93-2007 2 2007 NISO 4 Definitions The following terms, as used in this standard, have the meanings indicated. Term Definition client A computer system that connects over a network to a SUSHI server in order to retrieve usage statistics. COUNTER (Counting Onl
44、ine Usage of Networked Electronic Resources) An international initiative to facilitate the recording and exchange of online usage statistics. As used in this standard, refers to the reports defined by the initiative. electronic resources Digital information sources (e.g., online journal issues or da
45、tabases) accessible through a networked client computer. ERM (Electronic Resource Management system) A database and software system dedicated to handling the cataloging, licensing, accessing, and other aspects of electronic resource use. GUID (Global Unique Identifier) An identifier for an entity th
46、at is guaranteed to be unique within a global namespace, with a goal of unambiguously identifying that entity regardless of the context of the system or vendor. ILS (Integrated Library System) A set of automated library servicessuch as an online catalog, circulation management, and serial trackingth
47、at share a common database. release A version of a COUNTER Code of Practice and the reports defined within that Code. request A SOAP message sent from a client to a server requesting usage statistics for a specified customer and a desired report type. requestor An entity requesting usage statistics
48、on behalf of a customer. The requestor may be, but is not necessarily, the customer itself. response A SOAP message sent from a server to a client, containing the usage statistics for the customer specified in a request. server A computer system that responds to SUSHI SOAP messages and supplies usag
49、e statistics to a client over a network. SOAP (Simple Object Access Protocol) A protocol that specifies a self-contained messaging system used to exchange data and access services across a network (commonly the Internet). transaction A complete SUSHI exchange, comprised of a client-to-server request and a server-to-client response. usage statistics Reports detailing the use of a customers electronic resources over a given period of time. ANSI/NISO Z39.93-2007 2007 NISO 3 Term Definition Web service A server-based software system that provides information or
