1. VitalSource Customer Success
  2. Analytics and Insights
  3. Institutional Reports

Code Detail Report

Avatar
Brook Mecham
Follow

Purpose

Provides transaction-level details for all eBook code activity from Bookshelf.

Report Notes

  • User GUID added to help uniquely identify a Bookshelf end user

Definition of filters

Filter Name Description Usage Notes

Filter Criteria

(Required)

 A multi-versatile filter used to define the scope for viewing code details.

Defaulted to ‘Code Created (Date) OR Code Redeemed (Date)‘.

Select how you want to view the code details. Options include:

  • Code Created (Date) - narrows down the search to only codes based on Created (Date)
  • Code Redeemed (Date) - narrows down the search to only codes based on Redeemed (Date)
  • Code Created (Date) OR Code Redeemed (Date) - comprehensive search that includes all codes where the Created (Date) or Redeemed (Date) are in the same range.
  • Code Created (Date) AND Code Redeemed (Date) - narrows down the search to include only codes where the Created (Date) and Redeemed (Date) are in the same range (i.e. matching)

Date Range

(Required)

 Date range for when a code was created and/or redeemed based on the Filter Criteria selected. Use to set a date range, relative date (e.g. “last month”) or specific dates.
Code Status Current state of the Bookshelf code Narrow down the results based on the code status
VBID Item VBID that the Bookshelf code is generated against

Use to search for a specific asset or for many assets.

You can easily copy/paste multiple values. This can be completed by copying a column of ISBNs or VBIDs from an Excel-like document or copying ISBNs or VBIDs separated by commas.

🔵  Multi-search can support up to 16,000 values

⚠️ Copying ISBNs or VBIDs separated by semicolons does not work.
Item Name Name of the product accessed using the Bookshelf code Narrow down the results based on a specific name for the code-generating item
Product Type Indicates the product format that the code was accessed from Narrow down the results based on a specific format for the code-generating item
Code Distributor Name of the company that distributed the code (Manage Company Name) Narrow down the results by distributor
Publisher Name of the publisher related to the distributed asset Narrow down the results by Publisher

 

Definition of fields

Field Name Description
Code Status

Current state of the Bookshelf code

Included values:

  • Created - code has been created but not yet redeemed
  • Redeemed - code has been redeemed by an end-user
  • Cancelled - code was created and cancelled; no longer needed
VBID Item VBID that the Bookshelf code is generated against
Related Print ISBN Related print ISBN of the code generating VBID
Related Digital ISBN Related digital ISBN of the code generating VBID
Item Name Name of the product accessed using the Bookshelf code
Product Type

Indicates the product type that the code was accessed from

Included values:

  • Demo - indicates that the code was generated from a demo or sample-like product
  • Package - indicates that the code was generated from a package-like product
  • Rental - indicates that the code was generated from a rental or subscription-like product
  • Single - indicates that the code was generated from a perpetual-like product
Licence Duration (Online) Duration length for access to the online version of the material (in Bookshelf)
Licence Duration (Download) Duration length for access to the downloadable version of the material (in Bookshelf)
Bookshelf Code Code generated and delivered to access the asset
User GUID Unique identifier representing the Bookshelf code end user (assigned by the VitalSource system)
Code Distribution Reason Intended use for the Bookshelf code
Code Distributor Name of the company that distributed the code (Manage Company Name)
Code Creator Name of the application that generated the code (Manage System User)
Created (Date) Date when the code was created
Redeemed (Date) Date when the code was redeemed
Refund Expiration (Date) Date when the code is no longer eligible for refunds
Expiration (Date) Date when the code expires, if a discrete expiration exists
Cancelled (Date) Date when the code was cancelled
Code Tags Used to support additional data mapping (when needed)
Code Price

Code level price set when the Bookshelf code is created (where applicable)

📄 Price only applies when [a company] has worked with VST finance to use the code price to override other asset pricing.
Library Name Name of the library used to categorise assets based on a taxonomy (where applicable)
Asset Type

Indicates the asset type accessed using the Bookshelf code

🔵 Some values in this list require clarification as they do not represent a specific asset type:

  • Subscription - indicates that the asset is accessed through an Explore subscription.
Publisher Name of the publisher related to the distributed asset
Asset Redistributor Name of the company that distributed the asset (if not the Publisher)
Access Code

Publisher’s access code where an access code is required to access the asset (Courseware material only)

🔵 Only populated when Asset Type is ‘Online Resource’ or ‘Online Resource Bundle’.
Access Code Revealed Applies when Publisher’s Access Code is populated and is populated with ‘Yes’ when the publisher’s access code is revealed to the end user; otherwise, ‘null’

 

Was this article helpful?