COUNTER Schema Data Element Values
Code of Practice Release 4
Release 3 Code of Practice data element values have been moved.
The COUNTER 4.0 schema is purposely built to be flexible to allow growth and extension without the need for re-releasing of the overall schema. The flexibility of the schema is achieved through the use of several self-defining elements. Rather then enumerate the allowed values within the schema itself, 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. The COUNTER data elements and attributes can be derived from a series of registries and tables as noted below.
|
COUNTER Element |
Registry to use |
|
Report (name, title, & version attributes) |
|
|
Customer / InstitutionalIdentifer / Type |
|
|
ReportItems / ItemIdentifier / Type |
|
|
ReportItems / ItemDataType |
|
|
Report Items / ItemPerformance / Category |
|
|
ReportItems / ItemPerformance / Instance / MetricType |
A graphical representation of the COUNTER Release 4 Schema has been provided to help put these elements and attributes in context.
Report
The report(s) are defined through the main 'Report' element. Refer to the Reports Registry for the list of allowed report values.
IdentifierType
The values in this table are used to define the Type of identifier being used to identify institutions (InstitutionalIdentifier) and items (ItemIdentifier). Approved values for the Type elements are:
|
Type |
For use with |
Description |
|
Online_ISSN |
ItemIdentifier |
ISSN of the online version |
|
Print_ISSN |
ItemIdentifier |
ISSN of the print edition |
|
Online_ISBN |
ItemIdentifier |
ISBN of the online version |
|
Print_ISBN |
ItemIdentifier |
ISBN of the print version |
|
DOI |
ItemIdentifier |
Digital Object Identifier |
|
Proprietary |
ItemIdentifier |
For publisher or vendor specific identifiers |
DataType
The ItemDataType element under ReportItems defines the nature of the item the metrics are being gathered for. Approved values are:
|
ItemDataType |
Description |
Applicable Reports |
|
Journal |
Used for journal and consortium reports. |
JR1, JR1 GOA, JR1a, JR2, JR3, JR3 Mobile, JR5, CR1, TR1, TR2, TR3, TR3 mobile |
|
Database |
Used for database and consortium reports. |
DB1, DB2, CR2 |
|
Platform |
Defines the 'service' for book reports 4 & 6 and journal report 4 and database report 3. |
BR4, BR6, PR1, JR4 |
|
Book |
Used for books and reference works that may be included in the books reports and consortium reports. |
BR1, BR2, BR3, BR5, CR1, TR1, TR2, TR3, TR3 mobile |
|
Collection |
Used for grouping non-textual/multimedia items such as audio, video, etc. |
MR1, MR2, CR3 |
|
Multimedia |
Used for reporting full content item requests for non-textual items. |
CR1, TR1, TR2, TR3, TR3 mobile |
Category
The Category element under ReportItems / ItemPerformance element defines the nature of the usage data being gathered. Valid categories are listed in the first column. The second column lists which data type(s) (see table above) a given Category would apply to.
|
Category |
Applicable ItemDataType |
|
Requests |
Journal, Book, Multimedia, Collection |
|
Searches |
Database, Platform, Service |
|
Access_denied |
Journal, Book, Database, Service |
| Note: The Sessions category is no longer supported in COUNTER. | |
MetricType
In the COUNTER XML, one or more metrics can be reported for a given ItemPerformance element. Metrics are contained within an Instance element and each is defined by a MetricType element. Valid MetricType values and the Categories they apply to are:
|
MetricType |
Description |
Applicable Categories |
Changes |
|
ft_ps |
Postscript file full text requests |
Requests |
|
|
ft_ps_mobile |
Postscript file full text requests formatted for mobile device |
Requests |
New metric type |
|
ft_pdf |
PDF file full text requests |
Requests |
|
|
ft_pdf_mobile |
PDF file full text requests formatted for mobile device |
Requests |
New metric type |
|
ft_html |
HTML full text requests |
Requests |
|
|
ft_html_mobile |
HTML full text requests formatted for mobile device |
Requests |
New metric type |
|
ft_epub |
Full text requests delivered in EPUB format |
Requests |
New metric type for JR3 |
|
sectioned_html |
Used in Book Report 2, Consortium Report 1 and Title Report 1 to differentiate extent of book content delivered |
Requests |
New metric type |
|
ft_total |
Total full text requests |
Requests |
|
|
toc |
Table of Content Requests |
Requests |
Metric type now all lower case |
|
abstract |
Request for abstract view of article (detailed article metadata without full text) |
Requests |
|
|
reference |
Number of views to bibliographic references pages associated with an article |
Requests |
|
|
data_set |
Requests for supplementary data sets referenced in an article |
Requests |
Metric type now all lower case |
|
audio |
Requests for audio clips referenced in an article |
Requests |
Metric type now all lower case |
|
video |
Requests for video clips referenced in an article |
Requests |
Metric type now all lower case |
|
image |
Requests for images referenced in an article |
Requests |
Metric type now all lower case |
|
podcast |
Request for podcasts referenced in an article |
Requests |
Metric type now all lower case |
|
multimedia |
Number of successful full content requests for multimedia items (includes audio, video, image, podcast and other non-textual content items |
Requests |
New metric type |
|
record_view |
Count of detailed record-views for a database |
Requests |
New metric type |
|
result_click |
Count of clicks originating from a database search result list |
Requests |
New metric type |
|
search_reg |
Regular searches as conducted by users (excludes searches attributed to automated search processes and federated searches) |
Searches |
|
|
search_fed |
Searches conducted by federated search or automated search processes |
Searches |
|
|
turnaway |
Count of turnaways because simultaneous user limit exceeded |
Access_denied |
New metric type |
|
no_license |
Number of times users denied access because they were not licensed to access content |
Access denied |
New metric type |
|
other |
The 'other' category was provided for within the original COUNTER schema |
Access_denied (only for reasons other than turnaway or no_license |
|
| Note: The values "session_reg", "session_fed", and "count" are no longer supported in Release 4 of COUNTER CoP. | |||