Home | Schemas | SUSHI Schemas

Schemas for the Standardized Usage Statistics Harvesting Initiative (SUSHI)

 

About SUSHI Schemas

The SUSHI standard has three supporting XML schemas posted on the NISO website. The core schema (sushi[version].xsd) can be used with any conforming usage statistics reports.

If COUNTER reports are desired, the base schema calls up a second schema, the COUNTER-SUSHI schema (counter_sushi[version].xsd), which is also used. This schema references the COUNTER reports schema (counter[version].xsd), which creates an XML-formatted version of the requested COUNTER reports.

The two schemas with "sushi" in their name are basically retrieval envelopes for the XML-formatted COUNTER reports. The COUNTER XML schemas can be used separately from SUSHI by anyone who wants the reports in XML formats.

The links on the dates following the schema name are to a changes/correction webpage that provides information about what was changed in the particular schema. In some cases a link to a diagram illustrating the schema is available.

This webpage lists only the most current versions of the schemas. For previous versions, go to the Superseded SUSHI Schemas webpage.

 

SUSHI Namespace

The namespaces for SUSHI and COUNTER are defined within the COUNTER, SUSHI and COUNTER_SUSHI schemas on this site. To ensure the interoperability of this standard, namespaces must not be changed by implementers.

 

SUSHI Core Schema and WSDL

The core SUSHI schema is generalized to retrieve any compatible XML formatted usage statistics reports.

An accompanying Web Services Description Language (WSDL) file is also provided.

Diagrams

 

COUNTER-SUSHI Schema and WSDL

This schema is used with the core SUSHI schema if the usage reports to be retrieved are COUNTER reports. This schema is updated to match the most current version of the COUNTER XML reports schema and thus may have a higher version number than the core SUSHI schema. Each release of the COUNTER Code of Practice will require separate schemas.

 

Release 3 of the COUNTER Code of Practice

 

Release 4 of the COUNTER Code of Practice

The proposed Release 4 of the COUNTER Code of Practice has been published for comment on the COUNTER web site. The schemas listed below support this new proposed Code of Practice.

 

COUNTER Schemas

This schema is an XML version of the COUNTER reports. It can be used separately from SUSHI by anyone who wants the COUNTER reports in XML format. NISO and COUNTER have agreed that the SUSHI committee will maintain this schema to ensure that the SUSHI and COUNTER schemas are synchronized.

This schema can be used for any of the COUNTER reports (journals, databases, books, reference works, consortium). The flexibility of the schema is achieved through the use of several self-defining elements. Rather then enumerate the allowed values within the schema, these values are defined outside of the schema to allow new reports and metrics to be added without needing to update the schema each time.

Each release of the COUNTER Code of Practice has its own Schemas and supporting documentation.

 

Release 3 of the COUNTER Code of Practice

The values for the "Report" data element are listed in the Report Registry. Values for other elements can be found on the COUNTER Schema Data Element Values webpage.

See also the COUNTER FAQs for more information.

Note: These schema supersede earlier versions. See the correction notes for information regarding the changes made.

Diagram

 

Release 4 of the COUNTER Code of Practice

The proposed Release 4 of the COUNTER Code of Practice has been published for comment on the COUNTER web site. The schemas listed below support this new proposed Code of Practice.

The values for the "Report" data element are listed in the Report Registry. Values for other elements can be found on the COUNTER Schema Data Element Values web page.

  • counter4_0.xsd
    Description COUNTER schema with enumeration. (October 25, 2011)

Diagrams