SUSHI Reports Registry
for CoP Release 3 (Journals and Databases) and
CoP Release 1 (Books and Reference)
The SUSHI Reports Registry provides a listing of the standard report names and releases for COUNTER reports that should be used when implementing the schema. Also includes a registry of non-COUNTER reports that have been developed to work with the SUSHI protocol.
COUNTER Reports & Sample Files
When using the SUSHI protocol to retrieve COUNTER reports, the standardized report names as listed in the table below are to be used to ensure consistency across partners. The most current COUNTER schema will work with all the listed reports. Refer to the COUNTER Code of Practice for detailed descriptions of the reports.
The column headings map to elements and attributes in both SUSHI and COUNTER schemas as follows:
|
Column Heading |
Use in SUSHI Schema |
Use in COUNTER Schema |
|
Name |
Name attribute of the <ReportDefinition> element |
Name attribute of the <Report> element |
|
Title |
Not applicable |
Title attribute of the <Report> element |
|
Release / Version |
Release attribute of the <ReportDefinition> element |
Version attribute of the <Report> element |
The following table includes XML and Excel sample COUNTER payload files for each report for use in SUSHI testing. Additional files will be added as they become available.
|
Name |
Title |
Description |
Release |
XML Sample File |
Excel Sample File |
Large Sample File |
|
BR1 |
Book Report 1 |
Number of Successful Title Requests by Month and Title |
1 |
Sample report provided by Scholarly iQ |
||
|
BR2 |
Book Report 2 |
Number of Successful Section Requests by Month and Title |
1 |
Sample report provided by Scholarly iQ |
||
|
BR3 |
Book Report 3 |
Turnaways by Month and Title |
1 |
|||
|
BR4 |
Book Report 4 |
Turnaways by Month and Service |
1 |
|||
|
BR5 |
Book Report 5 |
Total Searches and Sessions by Month and Title |
1 |
|||
|
BR6 |
Book Report 6 |
Total Searches and Sessions by Month and Service |
1 |
|||
|
CR1 |
Consortium Report 1 |
Number of Successful Full-text Journal Article or Book Chapter Requests by Month |
3 |
Draft Under Review counter3_0_ example_cr1.xml |
||
|
CR2 |
Consortium Report 2 |
Total Searches by Month and Database |
3 |
Sample report provided by Scholarly iQ |
||
|
DB1 |
Database Report 1 |
Total Searches and Sessions by Month and Database |
3 |
Sample report provided by Scholarly iQ |
R3-DB1-csvexample.csv | |
|
DB2 |
Database Report 2 |
Turnaways by Month and Database |
3 |
Sample report provided by Scholarly iQ |
R3-DB2-csvexample.csv | |
|
DB3 |
Database Report 3 |
Total Searches and Sessions by Month and Service |
3 |
R3-DB3-csvexample.csv | ||
|
JR1 |
Journal Report 1 |
Number of Successful Full-Text Article Requests by Month and Journal |
3 |
Sample report provided by Scholarly iQ |
R3-JR1-csvexample.csv | |
|
JR1a |
Journal Report 1a |
Number of Successful Full-Text Article Requests from an Archive by Month and Journal |
3 |
counter3_0_ example_jr1a.xml Sample report provided by Scholarly iQ |
R3-JR1a-csvexample.csv | |
|
JR2 |
Journal Report 2 |
Turnaways by Month and Journal |
3 |
Sample report provided by Scholarly iQ |
R3-JR2-csvexample.csv | |
|
JR3 |
Journal Report 3 |
Number of Successful Item Requests and Turnaways by Month, Journal and Page-Type |
3 |
counter3_0_ example_jr3.xml Sample report provided by Scholarly iQ |
||
|
JR4 |
Journal Report 4 |
Total Searches Run by Month and Service |
3 |
counter3_0_ example_jr4.xml Sample report provided by Scholarly iQ |
||
|
JR5 |
Journal Report 5 |
Number of Successful Full-Text Article Requests by Year and Journal |
3 |
counter3_0_ example_jr5.xml |
R3-JR5-csvexample.csv | |
Other Reports
The SUSHI protocol will support the retrieval of reports other than COUNTER that meet the requirements specified in NISO Z39.93, section 6.2, Report Naming Requirements. Registration of these reports is voluntary but strongly recommended for any reports that might cross over business partners. Registration will be on a first come first serve basis for reserving a report name. NISO members may register reports for themselves or on behalf of their business partners. To register a report, send an email to: nisohq@niso.org.
|
Name |
Title |
Description |
Release / Version |
Registered by |
Schema location |