Skip to main content
OCLC Support

Setup one-time and recurring harvests

Use the Harvest Usage Data settings to configure vendors in order to harvest usage data for your e-resources based on vendor.

Harvest set up

Recurring Harvest

Once a harvest is scheduled for a configured vendor, it can be accessed through the Harvest History screen. For details, see Use the Harvest History.

Supported COUNTER report types include: 

  • COUNTER 3: JR1, JR1a, JR2, DB1, DB3
  • COUNTER 4: JR1, JR1 GOA, JR1a, JR2, JR3, JR3mobile, JR4, JR5, DB1, DB2, PR1, BR1, BR2, BR3, BR4, BR5, CR1, CR2, CR3, MR1, MR2, TR1, TR1mobile, TR2, TR3, TR3mobile
  • COUNTER 5: PR_P1, TR_J1, TR_J2, TR_B1, TR_B2, DR_D1

To schedule a recurring harvest:

  1. On the left navigation, click Usage Data.
  2. Click Harvest Setup.
  3. On the Harvest Setup screen, click the Recurring Harvest tab.
  4. From the Vendor Name list, select a vendor.
  5. The schedule and version available for the vendor are displayed.
  6. Select one or more Report Types to be harvested.
  7. Enter the Start Date of the harvest.  The system harvests the data from the date you enter until it reaches the most recent month.  From that point the system harvests based on the vendor's monthly schedule.  You can type in the date or click the calendar icon to select the date.
  8. Select the Status:
    1. Active: On (harvests occur according to the vendor's monthly schedule).
    2. Inactive: Off (ho harvesting occurs).
  9. Click Save.

One-time Harvest

Use this tab to harvest COUNTER files that have been downloaded manually from a vendor's website or transfer reports from configured vendors.  

Supported COUNTER report types include:

  • COUNTER 3: JR1, JR1a, JR2, DB1, DB3
  • COUNTER 4: JR1, JR1 GOA, JR1a, JR2, JR3, JR3mobile, JR4, JR5, DB1, DB2, PR1, BR1, BR2, BR3, BR4, BR5, CR1, CR2, CR3, MR1, MR2, TR1, TR1mobile, TR2, TR3, TR3mobile
  • COUNTER 5: PR_P1, TR_J1, TR_J2, TR_B1, TR_B2, DR_D1

To schedule a one-time harvest: 

  1. On the left navigation, click Usage Data.
  2. Click Harvest Setup.
  3. On the Harvest Setup screen, click the One-time Harvest tab.
  4. From the Report Source list, select a Source. Follow the instructions below based on your selection.
Transfer report file from my computer
  1. Select the vendor that published the COUNTER report you are uploading from the Vendor Name  list. This list scans the actively held collections in your knowledge base holdings and presents vendors in your collection.
  2. Select the Format of your file. 
    1. XML: available for all COUNTER 4 reports.
    2. Comma-delimited (CSV)
    3. Tab-delimited (TSV)
    4. EXCEL (XLS and XLSX)
  3. To add a file, click Browse.  Locate the file on your computer and click Open. 
  4. Click Validate.
  5. The version and report type of the file you uploaded is displayed.
  6. Enter the date range of the report into the Start Date and End Date fields, respectively.  You can type in the dates or click the calendar icons to select the date.
  7. Click Save.
Transfer report file from configured vendor
  1. From the Vendor Name list, select a vendor.
  2. The licensee, format, and version of the report are displayed.
  3. Select one or more Report Types to be harvested.
  4. In the Start Date field, enter the start date of the report.  You can type in the date or click the calendar icon to select the date.
  5. In the End Date field, enter the end date of the report.  You can type in the date or click the calendar icon to select the date.
  6. Click Save.

Format CSV and TSV file imports

License Manager requires COUNTER-compliant formatting for COUNTER 4 and COUNTER 5 file uploads.  CSV or TSV uploads are supported for the following list of journal, collection, and book reports:

  • Journal Reports: JR1, JR1 GOA, JR1a, JR2, JR3, JR3mobile, JR4, JR5, and TR_J1 (Excluding OA_Gold)
  • Collection Reports: DB1, DB2, and PR1
  • Book Reports: BR1, BR2, BR3, BR4, BR5, and TR_B1 (Excluding OA_Gold)
  • Multimedia Reports: MR1 and MR2 
  • Title Reports:  TR1, TR1mobile, TR2, TR3, and TR3mobile
  • Platform Reports: PR_P1

Use the below information to correctly format your report before uploading or to correct a previously uploaded report that returned errors.  

Metric type requirements

Most COUNTER reports include multiple metric types in addition to a summarized period value for each month (i.e. "Reporting Period HTML" in the JR1 report).  Because monthly breakdowns only include the "Reporting Period Total" metric type values, other metric types will be discarded for spreadsheet reports containing multiple months.  If individual metric types are important to import into License Manager, this can be accomplished by downloading individual monthly reports from your publishing vendor.

lman_individual_monthly reports.png

Report-specific requirements:
  • JR5: Number of successful full-text article requests by year of publication.
    • Because this report does not detail the data results by month of access, License Manager requires "Period covered by Report" values to be no greater than one month for JR5 reports.  This allows License Manager to combine and summarize monthly reports across different time periods.
    • In the image below, cell A5 can be no greater than one month:
      lman_J5_example.png
  • TR1: Number of successful requests for journal full-text articles and book sections by month and title.
    • Because this report includes a date header that differs from all other reports, License Manager has elected to require date headers in the same format as other reports (aside from the JR5).
    • It may be required that you reformat your date headers from (as an example) "Total MMM-YY" to the standardized "MMM-YYYY".  In other words, "Jan-2011" instead of "Total Jan-11".

Use the Harvest History

The Harvest History screen contains results on completed harvests (active and inactive recurring harvests and manual one-time harvests).  

Use the filters to select harvested reports by

  • Vendor
  • Harvest Configuration type
    • SUSHI
    • Manual
  • Result Counts
    • No Usage: the number of reports reporting no usage.
    • Error: the number of harvests reporting errors.
    • Success: the number of successful harvests.
    • Queued reports: the number of active harvests scheduled for each vendor. 
      • A value of 0 indicates the SUSHI vendor has been configured but is not actively being harvested against.
      • A persistent value of 1 indicates a recurring harvest is configured for each month

To change the sort order, click the Vendor, Version, or Harvest Configuration column.  

HARVEST Results

Click on View in the Details column to see information about the harvested reports for the selected vendor.

If the harvest completed, you will see links in the Results column to files:

  • Raw Data (.xml | .csv) - Lists successful full-text article requests by month and journal
  • Transformed Data (.xml | .csv) - In addition to the raw data, includes information about the library's license, collection and vendor.
  • For COUNTER 5 reports:
    • Original file- Shows the raw JSON report on the provider's SUSHI server.
    • Transformed data (XML | CSV)- In addition to the raw data, includes information about the library's license, collection and vendor.

If the harvest failed, you will see an error message as to why no data was harvested.

Harvest History Actions

Once you open the harvest history results for a vendor, you can select multiple rows of harvest results and perform a bulk action.

To perform a bulk action, check the row(s) you desire and use the Harvest History  Actions drop-down.  Choose any action:

  • Delete Harvest
  • Combine into Single CSV File
  • Extend delete date by one year

To view a license(s) associated with a harvest, expand Licenses and perform a search.  See Search for a License for more information.

Use the Harvest Summary

Use the Harvest Summary to generate a sum total of metric types across all COUNTER 4 reports harvested from publishing vendors.  The Harvest Summary will also indicate any missing reports from your collection of available vendors.

  1. From the Harvest History tab, enter the following information:
    • Report Type
    • Report Date Range
    • Metric Type
  2. Click Generate Harvest Totals to generate the Harvest Totals.
  3. Click View Report Coverage to determine if you have all the reports you need or if some need to be re-harvested.

On the Report Coverage screen, if a report month is missing for a specific vendor, click on Missing or No Usage from the report to re-harvest that missing month in one of two ways:

  1. For manual harvest configurations, you will be taken to the one-time harvest screen with the vendor and report type pre-selected.
  2. For SUSHI harvest configurations, you'll be shown a dialog box to automatically request the missing month from the pre-configured SUSHI vendor.