Third Party Enrichment
- 1 Accelerated Reader
- 2 Content and Cover Enrichment
- 2.1 ChiliFresh
- 2.2 COCE
- 2.3 Loral For Libraries
- 2.4 OMDb
- 2.5 Syndetics
- 2.6 Syndetics Unbound
- 3 Digital Public Library of America (DP.LA)
- 4 Good Reads
- 5 Google
- 6 JavaScript Snippets
- 6.1 Chat Platforms
- 6.2 ReciteMe
- 6.3 StackMaps
- 7 LibKey
- 8 Library Bookshelves (WordPress plugin)
- 9 New York Times
- 10 Novelist Select
- 11 Rosen LevelUp
- 12 Wikipedia
In this section, learn about:
All options for third party enrichment within Aspen
Options for paid enrichment
What credentials are needed for paid enrichment
Accelerated Reader
Aspen can pull in data weekly from Renaissance Learning based off of the record's ISBN.
To set this up go to Aspen Administration > Accelerated Reading Settings.
Generally, you'll want to click on Index Series and Index Subjects. The only reason you may not is because it generates extra subject data.
Enter your Accelerated Reader settings in the following fields:
AR Export Path = /data/aspen-discovery/accelerated_reader
FTP server URL = sftp.renaissance.com
FTP username = {provided with AR subscription}
FTP password = {provided with AR subscription}
In Catalog/Grouped Works > Grouped Work Display, you can select Show Accelerated Reader Information to show in your Search Results and Full Record Display.
In Catalog/Grouped Works > Grouped Work Facets, you can turn on the following facets:
AR Interest Level
AR Reading Level
AR Point Value
Content and Cover Enrichment
Cover images and other enrichment will begin to load immediately after inputting third-party credentials. Aspen checks for new cover images and enrichment every two weeks, beginning from when a record is first loaded.
Learn more about managing covers with the Cover Images documentation.
ChiliFresh
ChiliFresh is a paid subscription for catalog content.
COCE
COCE Server is a remote image URL cache that fetches and manages URLs directly from Amazon, Google Books, and Open Library.
Add COCE information in Aspen Administration > Third Party Enrichment > COCE Server Settings > Add New.
You will need to enter:
COCE Server URL - this is typically provided by Aspen support and hosting vendors
Save your settings with the floppy disc , Save Changes and Return, or Save Changes and Stay Here buttons.
Covers will be pulled in by UPC (024) or ISBN (020); the ISSN (022) is not used by COCE, but is used by other vendors like Syndetics.
Loral For Libraries
Add credentials
With a paid Loral for Libraries subscription, add your Loral credentials in Aspen Administration > Third Party Enrichment > Loral Settings > Add New.
You will need to enter:
A Name for your settings
Loral URL
Loral ID
Loral Password
Verify that Integration Enabled setting is checked, then select which Libraries the settings apply to, then save your settings with the floppy disc , Save Changes and Return, or Save Changes and Stay Here buttons.
Configure Full Record View
In Aspen Administration > Catalog/Grouped Works > Grouped Work Display > Full Record Display > More Details Options, administrators can choose to display the following Loral data:
Loral (All in One) - displays Author Notes, Syndicated Reviews, and Awards information
Author Notes (Syndetics/ContentCafe/Loral)
Syndicated Reviews (Syndetics/ContentCafe/Loral)
OMDb
The OMDb (Open Movie Database) is a web service that provides movie-related content and images contributed and maintained directly by OMDb users.
Add OMDb API credentials in Aspen Administration > Third Party Enrichment > OMDB Settings > Add new. API keys are typically provided by Aspen support and hosting vendors.
We recommend enabling the Fetch covers without dates for better cover accuracy.
OMDb images are pulled in by release year (from the 260 or 264 field) and the title, but if nothing is found in the database with the release date, just the title is used to identify the cover with this setting on.
Syndetics
Find your Syndetics Key
To set up Syndetics/Syndetics Unbound you will need your Syndetics Key (also known as a Client Code or Client Id).
Log into the ProQuest Syndetics Unbound dashboard or contact Syndetics support to obtain this key if you are having trouble. Within the Syndetics dashboard, this information can be found in Catalog Enrichments > Covers > Your Client Code.
Add Syndetics credentials to Aspen
As of 25.01, Aspen allows for multiple Syndetics collections to be used within an Aspen instance and/or allow the instance ID to be defined per library. If you are on an older version of Aspen, library scoping settings will not be available.
For each Syndetics subscription, navigate to Aspen Administration > Third Party Enrichment > Syndetics Settings > Add New.
Enter your Syndetics Key.
If you have Syndetics Unbound, click Syndetics Unbound and add your Unbound Account Number
Check/uncheck whichever options you need:
Applicable fields are Has Summary, Has Audio Visual Summary, Has Audio Visual Profile, Has Table of Contents, Has Excerpt, Has Fiction Profile, Has Author Notes, Has Video Clip.Select which libraries the settings apply to.
Save the settings. Once saved, you should begin to see content enrichment almost immediately.
Repeat the above steps for any additional Syndetics subscriptions that apply to your library systems.
Navigate to Aspen Administration > Catalog/Grouped Work > Grouped Work Display > click into the settings and scroll to Catalog Enrichment. Libraries can make choices about which types of enrichment they prefer.
Next, to make sure that the enrichment starts to display in the record, scroll down to Full Record Options.
For Syndetics Unbound, make sure the Syndetics Unbound option is also selected.
Syndetics Unbound
Configure in ProQuest
In order to set up Syndetics Unbound for your Aspen catalog, you will need to create an instance for Aspen Discovery in your ProQuest Syndetics Unbound Administration Dashboard.
To create a new instance in your Syndetics account, navigate to ProQuest Syndetics Unbound Home > OPAC Settings > Instances, then click Add Instance to set up the new instance.
Next, in OPAC Basics, select "Open Source" as the vendor, and "Aspen" for the product. Then enter the URLs for your library website, and your Aspen catalog URL.
Configure in Aspen Discovery
Follow the directions provided in the regular Third Party Enrichment section above.
To find your Unbound Account Number, navigate to this URL and log in to see your Unbound Account Number:
Syndetics Unbound.
You can also login to your account, go to ProQuest Syndetics Unbound Dashboard > Catalog Enrichments > Get Code and there is typically a 3-4 digit code there. This should be what you enter in Aspen Discovery in the Unbound Account Number field.
Set Up Syndetics Unbound Tags and FTP Server
Syndetics Unbound Tags can appear in the detailed record display:
For the Unbound tags to work correctly in Aspen, you'll have to upload a list of titles into Syndetics.
If you are using the Koha ILS, a Syndetics cron job to regularly transfer bib information via FTP. The system team setting up the FTP connection will need the following information:
Server
Username
Password
The information can be found in the ProQuest Syndetics Unbound Dashboard > Holdings > Upload Holdings via FTP.
If you are using another ILS, please reach out to your ILS support team or Syndetic support for more information on getting tags to work within Aspen.
User experience
Within the full record display, the Syndetics Unbound looks like this:
Digital Public Library of America (DP.LA)
Aspen allows you to show http://DP.LA content at the bottom of search results, if desired. Should you opt to use this feature, add the API Key to Aspen Administration > Third Party Enrichment > DP.LA Settings.
Add to search results
Once added, in Aspen Administration > Primary Configuration > Library Systems > scroll toward the bottom to the DPLA section (or search for DPLA) and click Include DPLA content in search results.
Add to combined search results
You can also choose to have DPLA results show up in Combined Results. You can set this up in Aspen Administration > Primary Configuration > Library Systems > Combined Results > Click Enable Combined Results.
In Combined Results Sections, choose the Display Name, the Number of Results to show, and pick the Source from the dropdown.
Once set up, you will have a in Combined Results section in your search dropdown.
Suppress titles
Libraries can suppress individual DPLA titles from displaying in Aspen’s search results.
Find the title that you would like to supress, hover over the title and right click to copy the link. Go to Third Party Enrichment > DP.LA Exclusions, click “Add New”, paste the link and save. The result will no longer display in the search results.
Good Reads
Aspen Discovery has a GoodReads integration that can bring in GoodReads reviews into bib records.
To see if GoodReads is turned on for your library, go to an item record and look for a menu that says Reviews from GoodReads like this:
Patrons can click on Write a review to be taken out to GoodReads where they can login.
To turn On/Off GoodReads, go to Aspen Administration > Catalog/Grouped Works > Grouped Work Display > click into your settings > Content Enrichment > check/uncheck Show GoodReads Reviews.
Scroll down to the Full Record Options.
Add GoodReads Reviews by clicking Add New and sort in the order you want it to show if you'd like to have it show in the item record.
Delete GoodReads Reviews by clicking Delete if you would like to remove it from the item record.
Google Analytics
To set up Google Analytics, go to Aspen Administration > Third Party Enrichment > Google API Settings. The following fields are applicable for analytics.
Google Analytics Version: Version 4
As of 25.12.00, version 3 is no longer an option. Support for GA3 ended on July 1, 2024.
Google Analytics Tracking ID: typically a value that starts with
G-(e.g.,G-PSW1MY7HB4)This field specifies a measurement ID that will be used for all traffic on the entire install unless more specific settings are tied to individual library systems
Library Google Analytics: (optional, for libraries with multiple measurement IDs)
Click Add New to add library-specific settings
Select the library system from the Library dropdown
Enter the Google Analytics Measurement ID in the textfield
To find your measurement ID, see
Measurement ID - Analytics Help.
The analytics data is only viewable via your Google Analytics account.
Stats include:
Number of users
Number of sessions started
Session length
Amount of returning users
Users by time of day
Number of page views
What links users are clicking on
Resources
Aspen Gathering Monthly Community Meeting- June 2021Watch from around 11:30 - 20:00 minute mark.
Talk to other libraries in the #analytics channel on the Aspen Slack workspace.
Google Tag Manager
You do not need Google API Settings for Google Tag Manager to work in Aspen. Just add a new JavaScript snippet in Local Catalog Enrichment > JavaScript Snippets with both tags from GTM, and select your library and locations.
For more information, see AspenCon2024 Workshop Materials by Tara Woods, SWAN.
Google Books API
The Google Books API key can be used to load covers only from Google.
If a library is using a COCE server integration, this setting isn't really needed because Google Books covers are included with COCE.
If you do want to load a Google Books Key, you can go to Aspen Administration > Third Party Enrichment > Google API Settings > Google Books Key.
Google Maps API
The Google Maps Key is used for geolocation within Aspen and to show a link to the map in the Hours and Locations popup.
The Google Maps API for each library is what makes the coordinates from their provided Location address (In Aspen Administration > Primary Configuration > Locations) for LiDA, too.
To add a Google Maps Key, go to Aspen Administration > Third Party Enrichment > Google API Settings > Google Maps Key.
Google Translate API
The Google Translation Key is used to provide a default translation for words in the Aspen interface when none exist already, like when adding a completely new language to Aspen or when a local translation has specific terms untranslated.
This API integration will not translate anything that is not manually translatable (e.g., grouped work titles or descriptions).
To add a Google Translate Key, go to Aspen Administration > Third Party Enrichment > Google API Settings and paste your API key value in the Google Translate Key and Confirm Google Translate Key text fields, then Save your settings.
When loading the interface in a new language for the first time with this key active, there may be some slowness while Aspen inserts all the translated values from the API. This slowness will not persist once those values are loaded in.
Terms translated by the Google Translate API will appear with a yellow ID button in Translation Mode.
Google reCAPTCHA
Once the SSL is set up for your domain, you can register the reCAPTCHA: https://www.google.com/recaptcha/admin/create
Once the domain is registered, you will receive a Public and Private Key.
Copy these into Aspen Administration > Third Party Enrichment > reCAPTCHA Settings.
The reCAPTCHA will be added to forms such as Self Registration and Custom Forms.
Troubleshooting reCAPTCHA
We typically recommend the Google reCAPTCHA set to the easiest Security Preference it allows for. If it is asking for multiple verifications, it is usually an indication that Google thinks something suspicious is going on.
If it is one terminal you are using for Self Registration (or other forms within Aspen):
Try Clearing the cookies, caches etc.
Make sure you use an updated, modern browser
Try switching browsers
JavaScript Snippets
Chat Platforms
Libraries can add Chat Platforms via JavaScript snippets in Aspen Administration > Local Catalog Enrichment > JavaScript Snippets > Add New > Select Libraries to publish to and Save.
Reach out to the Chat Platform vendor to receive the JavaScript snippet.
Snippets must include script tags <script> </script>
Common platforms we have seen libraries add are:
Library H3lp
Live Chat Inc
Olark
ReciteMe
Libraries can add ReciteMe to their catalog(s) via JavaScript snippets in Aspen Administration > Local Catalog Enrichment > JavaScript Snippets > Add New > Add in the code > Select Libraries to publish to and Save.
Find the needed JavaScript Snippet
ReciteMe provides the code needed here: https://knowledge.reciteme.com/knowledge/html.
To get the code click on Download Floating Button.
Copy the code on the screen.
Snippets must include script tags <script> </script>
Upload a button image
Upload their provided button or custom image into Aspen by going to Web Builder > Images > Add New > Give the image a name and upload the image or another custom image in the Full Size Image box. Once uploaded, click on View Image to get the unique URL for that image.
You're going to replace this bit of code with the Web Builder image source.
Example:
<script>
// Location of your button image:
var buttonSrc = '/WebBuilder/ViewImage?id=8';
</script>
Add Client Key
ReciteMe will provide you with a Client Key. In the code snippet look for the section that says CLIENT KEY GOES HERE and add your specific key (e.g., 1243748568756856697989089).
<script>
var serviceUrl
var serviceKey
var options
=
"//api.reciteme.com/asset/js?key="; "CLIENT KEY GOES HERE";
= {}; // Options can be added as needed
var autoLoad = false;
var enableFragment = "#reciteEnable";
Customize (Optional)
If you would like to make any customizations to the code snippet, like adjusting colors or location, that can be done within the provided code snippet.
StackMaps
While most JavaScript snippets require you to surround the code in opening and closing tags, do not include these for the StackMap snippet or it will not work.
If you have received a code snippet from StackMap configured for your instance of Aspen, you can add it via JavaScript Snippets.
Aspen Admin > Local Catalog Enrichment > JavaScript Snippets > click Add New.
Name your snippet, then paste in the code snippet. It may look something like this:
Check off applicable Libraries and Locations, then Save.
If successful, the StackMap integration should appear in records immediately.
LibKey
Administration settings
Assigning permissions
In Aspen Administration > System Administration > Permissions > Third Party Enrichment, enable Administer LibKey Setting, having selected the administrator role you wish to assign this permission to.
Adding your LibKey Credentials
In Aspen Administration > Third Party Enrichment > LibKey Settings, create a new LibKey Setting.
Name: assigned by you and can be set to any value
Library ID: to be obtained from ThirdIron
Api Key: to be obtained from ThirdIron
LibKey settings can be assigned to one or more libraries. It is also possible to create multiple LibKey settings, in case you happen to wish to use more than one set of LibKey credentials, should not all libraries in your Aspen system require the same.
User experience
LibKey for library catalog records
If a LibKey setting containing valid LibKey credentials has been assigned to a library, then, for any catalogue record on that library’s site that:
is of type eContent, and
has a DOI in its MARC field 851, and
for which LibKey is able to issue a direct link
a LibKey direct link will be issued, and the record will have its ‘Access Online’ button redirect patrons to the full-text document for that record via LibKey. Note: this will open a new tab.
LibKey links issued for records can also be seen under the ‘Links’ section on the ‘Full Detail View’ page for that record.
LibKey for EBSCOhost and EBSCO EDS records
The same applies as above, though with added features for these records, namely:
a retracted warning, if found, is displayed, and the ‘Access Online’ button will redirect user to a LibKey page giving more information on the retraction instead of redirecting them to the full-text document
if the LibKey API sends back a cover image url, then this will replace the cover image
Note: the LibKey integration currently does not cover records viewed on the Combined Results page.
Library Bookshelves (WordPress plugin)
Libraries using the WordPress Plugin Library Bookshelves can select Aspen API as a target Service.
For the Request URL, follow the parameters outlined in their documentation.
New York Times
The NYT Developer Portal was updated on Dec. 10, 2025. Existing API keys should still work, but you will need to re-create your account to manage your settings and upgrade to Aspen 25.12.00 to keep receiving updates.
Set up Best Sellers Lists
To add New York Times lists to your Aspen catalog, follow these steps. Once you've set up your NYT account and added the necessary credentials, the NYT Best Sellers lists will pull in automatically and Aspen will check for updates on a weekly basis.
Create an account: nyt-apigeex-prd-devportal
This will send you a confirmation email with a verification link that is active for 10 minutes. We have seen occasional bugginess with this. If the link takes you to an error page, try clicking it again until it says your email address has already been verified.
Once account has been created, sign in: nyt-apigeex-prd-devportal
Once signed in, click your email/username in the top right corner, then click Apps.
Click New App. Enter the App Name (ie "{LibraryName} NYT Lists") and give a description (ie "Aspen Discovery").
Next to the line that says Books API, click Enable. Then, click Save.
You will now see a section called API Keys. Click the Copy icon next to the Key to copy the key.
In another tab or window, log into Aspen and open up Aspen Administration > Third Party Enrichment > New York Times Settings. Click Add New. Paste in the key you just copied into both fields, then Save.
General Info
New York Times lists will only appear via the API if they have been updated within the last year.
Aspen will fetch list updates weekly. To check on New York Times indexing, you can go to Aspen Administration > User Lists > NYT Update Log.
You can manage the lists that show in Aspen in Aspen Administration > Third Party Enrichment > New York Times Lists. You can see last updated date for the list and delete any lists you do not want.
Titles will only show on the lists if you own a copy of the title. If the NYT List has 25 titles on it but your library only owns 15 of the items, only 15 items will show up on the list in Aspen.
To display titles in these lists, Aspen is matching ISBN numbers from the list(s) to your bibliographic data.
When the lists are loaded, they will show up in Lists and the "Created By" will show as The New York Times.
Learn more about lists in theListsdocumentation.
Novelist Select
If you subscribe to Novelist Plus, verify that Novelist Select is available with your subscription.
With a paid NoveList Select subscription, add your NoveList Select credentials in Aspen Administration > Third Party Enrichment > NoveList Settings > Add New.
You will need:
Profile ID (e.g.,
s1234567.main.novselcsc)Profile Password
Select which Libraries the settings apply to, then save.
If you have an existing NoveList profile for your previous OPAC/ILS, you may need to reach out to EBSCO support to make sure you're set up correctly. Email novelistselectsupport@ebsco.com and let them know you'd like to create a profile specifically for Aspen Discovery.
Classic Aspen integration
Once NoveList Select credentials are added go to Aspen Administration > Catalog/Grouped Works > Grouped Work Display > click into your settings:
In the Full Record Options section at the bottom, you can tailor your NoveList related options:
Similar Series from NoveList
Similar Titles from NoveList
Similar Authors from NoveList
Novelist click stats are not available in the Novelist dashboard with the classic Aspen integration. Click stats are available when using the All in One integration.
Similar Authors from Novelist
Similar Authors from NoveList will show a related list of authors in the record.
When you click on these options, they will take you to a quoted author search.
This is a more general list so some results may turn up no results.
In search results, a user can click on the author's name hyperlink in the grouped work display to be redirected to an Author search in Aspen.
Similar Series from Novelist
Similar Series from NoveList will show a list of related series.
A user can click on a hyperlink to be redirected to a Keyword search of that series in Aspen.
This is a more general list so some results may turn up no results.
Similar Titles from Novelist
Similar Titles from NoveList will show similar titles in the item record.
Titles without covers and/or without a hyperlinked title, are not available in your collection. If you click on the other covers and/or hyperlinks, this will take the user out to that item's record in your catalog. These titles can be available anywhere on the library server.
Unlike the Series and Author searches, Similar Titles will only display hyperlinks when the items are available in your catalog.
All in One integration
As of the 24.05 release, Aspen Discovery now has a second NoveList Select option called Novelist (All in One). To enable it, go to Aspen Administration > Catalog/Grouped Works > Grouped Work Display > click into your settings:
Within Full Record Options at the bottom, add NoveList (All in One).
Within the record, the integration will look like this:
When covers are clicked, users are sent to keyword searches within the catalog. Note that the All in One integration may show titles that are not available in your catalog.
Consortia
If you are a library system in a consortia, you may need to reach out to NoveList to have them configure your profile so that Aspen Discovery can correctly keep users within the scoped catalog instead of redirecting out to the “main” consortial catalog.
You can try making the change yourself in EbscoAdmin under: Site/Group Maintenance > Consortium > Custom Links. There are two new Custom Links: NovSelectAuthorCatalogLink_Aspen and NovSelectAuthorTitleCatalogLink_Aspen:
Troubleshooting
Read the Q&A (page 4) of this Aspen Weekly for common questions and how to resolve them.
If you're still running into issues after working with NoveList Select support, you may also need to enable "On the Shelf" (OTS) in your NoveList Select profile.
This link to the EBSCO Help documentation explains more details about the integration, information on sending your location holdings, and more.
Series integration
If you have NoveList Select, Aspen Discovery can use the series and volume information from NoveList.
When you click on the series hyperlink (pictured above), Aspen will take you into a different view (pictured below), which sorts the series in volume order from 1, 2, 3 and so on.
Disable series integration
Whether you are using Novelist Select’s classic or All in One integration, the Novelist series integration features can be turned off in Aspen Administration > System Variables > Enable Novelist Series Integration.
This will turn off the display of Novelist series name and volume in the full record display in the grouped work and the Also in This Series feature for the Aspen classic integration (pictured below).
With Novelist disabled, Aspen will use the series information from the ILS and/or eContent from the following fields:
MARC 830anp 830v, 800pqt
If not found in above data, then it will look at the MARC 490 field
OverDrive: series
Hoopla: series & episode
Novelist API information
To see what information Aspen is getting from the NoveList API, go to Aspen Administration > Third Party Enrichment > Novelist API Information and enter the ISBN you want to test in the ISBN field.
Rosen LevelUp
In Aspen Administration > Third Party Enrichment > Rosen LevelUp Settings you can customize your Rosen LevelUp options.
Add PTypes that can register for Rosen LevelUP
LevelUP API Host
LevelUP API Username
LevelUP API Password
LevelUP Multi-District Name
LevelUP District Name
LevelUP School Name
School Location Code Prefix
You can provide your patrons with a simple way to register for accounts with your school library's Rosen LevelUP subscription
Instruct patrons to:
Go to {$SITE_URL}/MyAccount/Rosen/RegisterRosenLevelUP and log in as the student
Fill out the form with student and parent information
A single parent username can be used to register multiple students
Wikipedia
Wikipedia information is brought in by via web-scraping, where we basically are pulling in live information from Wikipedia, however we do cache the information so immediate changes to Wikipedia will not be reflected right away in Aspen because we cache the information for one day.
Enable or disable integration
To turn on the Wikipedia Integration in Aspen, go to Aspen Administration > Primary Configuration > Library Systems > Catalog Enrichment > check Show Wikipedia Content.
When a user clicks on a hyperlinked Author name, the Wikipedia description will pop up.
Modify or Hide author information
You will need the permission Administer Wikipedia Integration to complete these steps.
Once you have this permission, go to Aspen Administration > Third Party Enrichment > Wikipedia Integration > Click Add New.
Enter in the Author Name you want to update as it appears in the 100ad.
Next, you have a couple options:
Check Hide Information to completely hide the author's Wikipedia information from appearing in Aspen. You would typically do this if the author has no valid Wikipedia URL to prevent Aspen from directing to an incorrect page. If hiding the Wikipedia information, this change should reflect immediately.
To redirect an author link to the correct Wikipedia URL (if one exists), enter in the correct Wikipedia URL.
Save your changes when finished.
Due to browser caching, you may need to force a reload of your page or open in another browser to make sure the changes are applied.