Third Party Enrichment

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

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. and Olark.

COCE Server is a remote image URL cache. With this option, cover images are not fetched directly from Amazon, Google, and Open Library. Their URLs are requested via a web service to Coce which manages a cache of URLs.

• • Coce currently will check Amazon Web Services, Google Books or Open Library.
  • We grab book/magazine/etc. covers with UPC (024) or ISBN (020). We do not currently use ISSN (022) but vendors like Syndetics do.

Learn more about Cover Images here.

Add DPLA Credentials

If you choose to use the DP.LA (Digital Public Library of America) API, add the API Key to Aspen Administration > Third Party Enrichment > DP.LA Settings

Add DPLA to Search Results

Once added, in Aspen Administration > Primary Configuration > Library Systems > scroll toward the bottom to DPLA and click Include DPLA content in search results. This will make DPLA results will show up at the bottom of search results.

Add DPLA to Combined 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.

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

• Select your Google Analytics Version - Version 3 or Version 4  
  • Note: Although Aspen shows Version 3, starting on July 1, 2023, Google Analytics Version 3 standard Universal Analytics properties stopped processing new data, and all customers will lose access to the Universal Analytics interface and API starting on July 1, 2024.
• Add your Google Analytics Tracking ID - typically a UA number
• Add your Google Analytics Linking ID - if applicable
• Add your Google Analytics Linked Properties (one per line) - if applicable
• Google Analytics Domain Name - if applicable

• One of ByWater's library partners did a presentation on this in 2021: https://youtu.be/JEUt4skOIfA?t=690 Watch from around 11:30 - 20:00 minute mark.
• Andrew Fuerste-Henry of Dubuque County put together these Tango tutorials:
  • Set GA4 to capture search terms
  • See your Aspen search terms
• Talk to other libraries in the #analytics channel on the Aspen Slack workspace.

Google Books

The Google Books API key can be used to load covers only from Google, but if a library is using COCE information, it isn't really needed.

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

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.

Setting up New York Times 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.

1. Create an account: https://developer.nytimes.com/accounts/create

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.

2. Once account has been created, sign in: https://developer.nytimes.com/accounts/login

3. Once signed in, click your email/username in the top right corner, then click Apps.

4. Click New App.

5. Enter the App Name (ie "{LibraryName} NYT Lists") and give a description (ie "Aspen Discovery").

6. Next to the line that says Books API, click Enable. Then, click Save.

7. You will now see a section called API Keys. Click the Copy icon next to the Key to copy the key.

8. 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.

New York Times lists: 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 Here

During implementation, the Aspen support team will set up with our key in the OMBD Settings in Aspen Administration > Third Party Enrichment > OMDB Settings. We suggest unchecking Fetch covers without dates for better accuracy. 

OMDb (Open Movie Database) - The OMDb is a web service to obtain movie information where all content and images on the site are contributed and maintained by OMDb users. These are pulled in by release year (lives in publication date field, 260/264) and title, but if we don't get anything with the release date, we try to pull it off title.

Due to there being common titles/release years in the database, we sometimes see mix-matches in covers. You can replace covers by uploading a new image and the uploaded image will trump the OMBD image. This enrichment is free to you and best for libraries who don't pay for a cover service. Libraries can remove this cover service and request that you Aspen support team clear out covers related to this resource.

Learn more about Cover Images here.

Check out this page on our Help Center for more information on Quipu.

Once the SSL is set up for the 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

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.

Gather the Needed Code

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: var buttonSrc = '/WebBuilder/ViewImage?id=8';

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.

Replace this with the provided Client Key. Keep the " " around the key.

Example: "1243748568756856697989089"

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 code snippet.

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

StackMap

While there are no settings in Aspen or API connections available for Stack Map at this time, we do allow Stack Map integration via JavaScript Snippets. 

Below is an example of what StackMap integration looks like on Flagstaff Public Library (note the blue "Map It" button beneath the call number):

Adding StackMap Code to Aspen

If you have received a code snippet from StackMap configured for your instance of Aspen, you can add it via JavaScript Snippets.

1. Aspen Admin > Local Catalog Enrichment > JavaScript Snippets > click Add New.
2. Name your snippet, then paste in the code snippet. It may look something like this:

Note: 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.

3. Check off applicable Libraries and Locations, then Save.

If successful, the StackMap integration should appear in records immediately. 

If you need help integrating StackMap into your discovery layer, please reach out to your support company for assistance. You can reach out to StackMap to obtain the necessary code and ByWater support can help troubleshoot to make sure everything is configured correctly with StackMap.

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. 

Turn On/Off Wikipedia 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 Wikipedia Author Info

First, you will need the permission: Administer Wikipedia Integration added to your role.

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:

1. 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. 
2. To redirect an author link to the correct Wikipedia URL (if one exists), enter in the correct Wikipedia URL.

Save your changes when finished.

In either case, 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.

Libraries using the WordPress Plugin Library Bookshelves can select the Service as Aspen API (see their documentation screenshot below):

For the URL, follow the parameters outlined in their documentation.

To link to an existing list, use:

{catalog URL}/API/ListAPI?method=getListTitles&id={list ID}

You can find the List ID in the browser of your list. It is the number at the end of the URL.

To link to a keyword search, use:

{catalog URL}/API/SearchAPI?method=search&lookfor={keyword}&pageSize={# of results} replacing the keyword and the number of results you want to show

Exp: library.aspendiscovery.org/API/SearchAPI?method=search&lookfor=pizza&pageSize=25

To link to an existing browse category, use:

{catalog URL}/API/SearchAPI?method=search&filter{fill in the browse category parameters}

You can find the browse category parameters by clicking into the browse category you want to use and copying all the information after filter into the URL

Testing and Authorizing the IP Address

Once you have the URL configured, enter it into your browser.

If you are seeing a message like this: 

Forbidden - API requests from XX.XX.XXX.XX are forbidden

Then, go to Aspen Administration > Primary Configuration > IP Addresses > Add New > Add the IP address you see in the browser and uncheck everything except for Allow API Access > Save.

Now, refresh the browser with the URL. You should see code on the screen instead of the forbidden message and should be all set.

Please note: We have no control over the customization of this integration. If you need additional help, please reach out to the developer of the plugin.

If you are interested in creating Collection Spotlights via Aspen Discovery, please see this page of the Help Center.

If you have a ContentCafe subscription, go to Aspen Administration > Third Party Enrichment > ContentCafe Settings > Add New 

You will need:

• Content Cafe ID
• Profile Password
• Check Has Summary, Has Table of Contents, Has Excerpt, and Has Author Notes

Note: If ContentCafe/Baker & Taylor is down or experiencing slowness, there is an Integration Enabled option you can uncheck to temporarily disable. 

Cover images and other enrichment will begin to load immediately after inputting your credentials.

Once ContentCafe is set up, in Aspen Administration > Catalog/Grouped Works > Grouped Work Display > click into your settings:

In the Catalog Enrichment section, click Prefer Syndetics/Content Cafe Description if you'd like to use the enrichment option over those in your marc records.

In the Full Record Options section, you can tailor your Content Cafe related options:

• Table of Contents (MARC/Syndetics/ContentCafe)
• Excerpt (Syndetics/ContentCafe)
• Author Notes (Syndetics/ContentCafe)
• Syndicated Reviews (Syndetics/ContentCafe)

Cover images and other enrichment will begin to load immediately after inputting your credentials.

Aspen checks for new cover images and enrichment every two weeks, beginning from when a record is first loaded.

In the record, go to Staff View > Reload Cover and/or Reload Enrichment can force a sooner update.

Learn more about Cover Images here.

With a paid NoveList Select subscription (if you subscribe to NoveList Plus, check that this is available with your subscription), add your NoveList Select credentials in Aspen Administration > Third Party Enrichment > NoveList Settings > Add New.

You will need:

• Profile ID (Ex: s1234567.main.novselcsc)
• Profile Password

Select which Libraries the settings apply to, then save.

Note: 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. If you are migrating to Koha, you can ask them to create a profile for the Koha staff client URL as well.

Enrichment will begin to load immediately after inputting your credentials.

If you are using Novelist Select (either classic or All in One), you can decided to turn off Novelist's series integration features.

This will turn off the Also in This Series feature within the record display (seen below).

This will also turn off the display of Novelist series name and volume in the full record display in the grouped work.

Instead, 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

To enable/disable, go to Aspen Administration > System Variables > Enable Novelist Series 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

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.

If available, a Similar Authors section will appear in the left hand corner. Users can hover over these suggestions to see why they are recommended.

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.

Note: Unlike the Series and Author searches, Similar Titles will only display hyperlinks when the items are available in your catalog.

As of the 24.05 release, Aspen Discovery now has a second NoveList Select option called Novelist (All in One).

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 add:

• NoveList (All in One)

Within the record, the integration will look like this:

Currently there is no modification/customization in Aspen Discovery for these sections. 

When you click on the covers, they will take you to keyword searches within the catalog.

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 your 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. 

Hyperlinked Series Information

If you have NoveList Select, Aspen Discovery can use the series and volume information from NoveList.

When you click on the series hyperlink, Aspen will take you into a different view, like pictured below, and sort the series in volume order from 1, 2, 3 and so on.

For something like "InvestiGators", Aspen will show the titles in the John Green series and not utilize the stemming if series information is available from Novelist Select.

If you see an error or want to change the series and volume information that is displaying in the grouped work display, you can click into the Grouped Work (you know you are in the Grouped Work because the URL will be: https://{YOURASPENURL}/GroupedWork/{GroupedWorkID}) and go to Staff View > Set Display Info

A box will pop up for you to enter in the information you want to display.

Click on Set Display Info to save your work.

There may be some browse cacheing that occurs, so changes might take a force reload of the page. 

Note: This only effects the display in Aspen and does not push any changes to bib records and/or the ILS. 

To see what information Aspen gets 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.

As of the 24.05 release, Novelist click stats will be available in the Novelist dashboard if the library is using the Novelist All in One integration.

Click stats are not available with the Aspen Classic Integration.

To set up Syndetics/Syndetics Unbound you will need your Syndetics Key (also called the Client Code).

You should be able to log into the ProQuest Syndetics Unbound dashboard or contact Syndetics support to obtain this if you are having trouble.

In the ProQuest Syndetics Unbound Dashboard > Catalog Enrichments > Covers > Your Client Code > This should be what you enter in Aspen in the Syndetics Key field.

If you have a Syndetics account, but not Unbound, go to Aspen Administration > Third Party Enrichment > Syndetics Settings > Add New > Enter the Syndetics Key.

Next, select any of the options you'd like to pull in:

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 selected.

For Syndetics, there are other options like Table of Contents, Excerpt, and Author Notes if those are available with the subscription.

Enrichment will begin to load immediately after inputting your credentials.

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. 

Next, you will need to configure the Links and URLs. The supported URL types are ISBN, Keyword, and Title.

Fill in with your Aspen catalog URL, filling in the {YourAspenURL}

Example: https://mainlibrary.org/Union/Search?view=list&lookfor=UNBOUNDREPLACE&searchIndex=Keyword&searchSource=local

ISBN URL:

https://{YourAspenURL}/Union/Search?view=list&lookfor=UNBOUNDREPLACE&searchIndex=Keyword&searchSource=local

Keyword URL: 

https://{YourAspenURL}/Union/Search?view=list&lookfor=UNBOUNDREPLACE&searchIndex=Keyword&searchSource=local

Title URL:

https://{YourAspenURL}/Union/Search?view=list&showCovers=on&lookfor=UNBOUNDREPLACE&searchIndex=Title&searchSource=local

If you are using Syndetics Unbound with an existing catalog other than Aspen, you will need to make sure the Aspen instance you created is the primary instance when you're ready to go live.

In the below screenshot, the existing Enterprise instance is still the primary, so you would need to enable Aspen as the primary instance in order to see Unbound integration in Aspen.

Customize Unbound Content that Shows in Aspen

The Unbound configuration can be customized in the Syndetics dashboard.

To have these configuration options apply in Aspen Discovery, Aspen must be the primary instance.

If you have a Syndetics subscription, navigate to Aspen Administration > Third Party Enrichment > Syndetics Settings > Add New.

1. Enter your Syndetics Key. (This is typically composed of letters and is some variant of your library name. Syndetics calls this the 'client id')
   • Contact Syndetics support if you do not have your client ID.
2. If you have Syndetics Unbound, click Syndetics Unbound and add your Unbound Account Number
3. Check/uncheck whichever options you need:
   • 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
4. Save the settings. Once saved, you should begin to see content enrichment almost immediately. 

Next, head over to Aspen Administration > Catalog / Grouped Works > Grouped Work Display > click into your library's settings

1. In the Catalog Enrichment section, make sure Prefer Syndetics/Content Cafe Description is checked.
2. In the Full Record Options section, you can tailor your Syndetics related options:

• Table of Contents (MARC/Syndetics/ContentCafe)
• Excerpt (Syndetics/ContentCafe)
• Author Notes (Syndetics/ContentCafe)
• Syndicated Reviews (Syndetics/ContentCafe)

Learn more about Cover Images here.

To find your Unbound Account Number, log into your Syndetics account.

You can also navigate to this URL and log in to see your Unbound Account Number: https://admin.syndetics.com/enrichments/getcode

or

In the ProQuest Syndetics Unbound Dashboard > Catalog Enrichments > Get Code > there should be a (typically) 3-4 digit code.

This should be what you enter in Aspen Discovery in the Unbound Account Number field.

The 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 also using the Koha ILS supported by ByWater Solutions, please submit a Koha support ticket and request a Syndetics cron job to regularly transfer bib information via FTP. You will need to supply us with the following credentials:

• Server
• Username
• Password

This information can be found in ProQuest Syndetics Unbound > 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.

Within the record display, Syndetics Ubound looks like this: