Aspen uses API connections for the following vendors:
Boundless
cloudLibrary
hoopla
OverDrive (Libby and Sora)
Palace Project
Once credentials are in place for eContent, library staff no longer need to manually load these records into the ILS.
By default, Aspen suppresses eContent records from your ILS in favor of eContent via the API connections.
With this direct API connection, users will be able to manage their checkouts and holds, and return and renew items (if that functionality is available), all from within the user account.
In July 2023, Baker & Taylor announced that Axis 360 will be renamed Boundless.
Set Up
To add Boundless, turn the module on in Aspen Administration > System Administration > Modules.
Once enabled, a new menu, Boundless, will appear in Aspen Administration.
In Boundless > Settings you will need:
User Interface URL
Username (ByWater Aspen Team Has)
Library Prefix (ByWater Aspen Team can reach out to B&T to get)
In Boundless > Scopes, you can create a new scope and apply it to certain libraries and/or locations.
You'll also want to go to Aspen Administration > Primary Configuration > Library Systems > Boundless (toward the bottom) and make sure the correct scope is selected from the dropdown.
As of the 24.04 release, Aspen now has the ability to scope Boundless by age/audience.
To view your options, go to Aspen Administration > Boundless > Scopes > click into your existing scope or Add New
A common use for scoping this content is for a seperate kid's catalog. Then, the library can show off their full collections in their main catalog and only show off their kid's or teens materials in their other catalog.
The options are:
Include Adult Titles
Include Teen Titles
Include Kids Titles
Aspen uses grade level and subject data via the API to determine these categories:
If there are indicators of Children's or Juvenile, then the audience will be Juvenile and be in the Include Kids Titles option
If there are indicators of Teen or Young Adult, then the audience will be Young Adult and be in the Include Teen Titles option
If there are indicators of General Adult or Adult, then the audience will be Adult and be in the Include Adult Titles option
This data count be found within the detailed record page > Staff View.
These settings take a Nightly Index to fully update.
Once loaded, titles will show and group with other physical and econtent you have loaded. From the grouped work display users can check out from Boundless.
My Account
Checked out titles from Boundless will show in My Account > Checked Out Titles with the rest of the user's physical and electronic items.
Titles on Hold from Boundless will show in My Account > Titleson Hold with the rest of the user's physical and electronic holds.
This information is synced across platforms so anything checked out directly from the Boundless site, app or Aspen by this user will all show here in one place.
Account Settings
In My Account > Account Settings > Boundless Options there is an option to control the email address that alerts users about holds placed through Aspen on Boundless items.
IncloudLibrary>Scopes, you can create a new scope and apply it to certain libraries and/or locations.
You'll also want to go toAspen Administration>Primary Configuration>Library Systems> cloudLibrary(toward the bottom) and make sure the correct scope is selected from the dropdown.
The cloudLibrary API will only share OWNED titles from your library/libraries and will not share titles that may be available as sharing/pay per use collections that are shown on the cloudLibrary site.
As of the 24.04 release, Aspen now has the ability to scope cloudLibrary by age/audience.
To view your options, go toAspen Administration>cloudLibrary>Scopes>click into your existing scopeorAdd New
A common use for scoping this content is for a seperate kid's catalog. Then, the library can show off their full collections in their main catalog and only show off their kid's or teens materials in their other catalog.
The options are:
Include Adult Titles
Include Teen Titles
Include Kids Titles
Aspen uses information in the 650 subject data of the cloudLibrary records to determine these categories:
If there are indicators of Juvenile, then the audience will be Juvenile and be in the Include Kids Titles option
If there are indicators of Young Adult, then the audience will be Young Adult and be in the Include Teen Titles option
If there are indicators of Adult, then the audience will be Adult and be in the Include Adult Titles option
These settings take a Nightly Index to fully update.
Once loaded, titles will show and group with other physical and econtent you have loaded. From the grouped work display users can check out from cloudLibrary.
My Account
Checked out titles from cloudLibrary will show in My Account > Checked Out Titles with the rest of the user's physical and electronic items.
Titles on Hold from cloudLibrary will show in My Account > Titleson Hold with the rest of the user's physical and electronic holds.
Owned Titles vs. cloudLibrary marketplace Titles
Because cloudLibrary only shares owned titles, titles not owned by the library checked out via the shared/pay per use collection, will show by default as Unknown cloudLibrary Title and the management of those will take place on the cloudLibrary website.
This messaging is translatable in Aspen Administration > Languages & Translations > Translations > search for unknown cloud to find. Here are a couple sample messages that libraries have updated for a better user experience.
As of the 24.08 release, you have the ability to set up alternate library cards to work with cloudLibrary -- for example, if users have access through a state library card.
To add Hoopla, turn the module on inAspen Administration > System Administration > Modules.
Once enabled, a new menu, Hoopla, will appear in Aspen Administration.
Create Settings
InHoopla>Settingsyou will need:
Library Id (Reach out to Hoopla or your Aspen Support Team for this)
(AspenSupport vendor will provide)
API Password (AspenSupport vendor will provide)
Index by Day:
Add hoopla ID to Library System Settings
You will also need to put the Hoopla ID number in Primary Configuration > Library Systems > click into that library system >Hoopla Library ID.
If you see titles are loaded in but no "Check Out" button next to the hoopla titles, double check that your hoopla ID is entered in your Library System settings.
For consortia: When setting up Hoopla during implementation, ByWater support will enter in one your libraries' Hoopla IDs in the Settings. Typically, this will be the first hoopla ID we're provided with (alphabetically), but any of your library Hoopla IDs can be entered into these settings. Then, the indiviudal Hoopla IDs tied to the libraries are entered in Library Systems > Hoopla ID. By only using one hoopla ID for the hoopla settings, this prevents Aspen from having to index a million plus records per library system. Instead, we use a single collection for indexing, and then scope this out to all the individual member libraries, entering their unique IDs in the library system settings.
Create Scope
If first setting up hoopla, Go to Hoopla > Scopes > Add New
The scope can be published to the library catalog either from hoopla > Scopes > scroll down and check off the Library and Locations or from Primary Configuration > Library Systems > click into that library system > Hoopla scope > select scope from dropdown.
InHoopla>Scopes, you can create a new scope and apply it to certain libraries and/or locations.
Note: These changes do not make changes to your Hoopla collection available via Hoopla's site or app, just the results that will display in your Aspen catalog.
Exclude Records With Copies from other eContent Vendors
Exclude Records With Copies from other eContent Vendors (OverDrive, cloudLibrary,Axis 360, etc.) you have a few options to choose from:
No show all titles
Hide Hoopla title if other copies are available
Hide Hoopla title if other copies are owned - A library may consider to hide Hoopla titles and only show other options for Hoopla cost savings, especially for "classics" or other titles that are readily available in many other formats.
Exclude Collections and Set Up Cost Per Checkout Per Collection
There is also the ability to restrict showing a Hoopla title by cost and/or by Hoopla collection. If the price is greater than then amount set, the record will not show in Aspen.
Libraries can also choose to include/exclude the following collections:
eBooks
eComics
Movies
Music
Television
Binge Pass
Exclude by Audience
As of the 24.04 release, libraries now have the choice to limit down by:
Include Adult Titles
Include Teen Titles
Include Kids Titles
To determine these audience categories:
We check if the 'Children' flag is on, then we check the rating.
If there is a Children's flag, then the audience will be Juvenile and be in the Include Kids Titles option
If we don't get the 'Children' flag or the rating, next we check the genres.
When determining audience for Hoopla titles by genre, anything with a genre starting with Young Adult is Young Adult and will be in the Include Teens Titles option.
NRC (Not Rated - Appropriate for Children) titles have an audience of Juvenile and be in the Include Kids Titles option
NRT (Not Rated - Appropriate for Teens) titles to have an audience of Young Adult and be in the Include Teen Titles option.
If a TV show has a rating of G or TVG, the audience will also be "General" and be in the Include Adult Titles option.
If none of these above rules apply, the audience will be Adult and be in the Include Adult Titles option.
This data can be found within the detailed record page > Staff View.
Below is an example of a Hoopla title with the "Children" flag on (value = '1').
Below is an example of a Hoopla title with no value in the "Children" flag.
Next, Aspen checks the genre. The genre is "Drama" and there are no genres indicating the audience should be Young Adult, so Aspen will use the Adult audience for this title.
Exclude by Ratings
In Ratings to Exclude, include any Ratings that you don't want in your catalog. These are based on hoopla's rating scale. If there are multiple, seperate by pipes. Reach out to hoopla with any questions on these ratings.
Exclude by Abridged, Parental Advisory and Records with Profanity
You can choose:
Exclude Abridged Records (recommended due to the volume of records)
Exclude Parental Advisory Records
Exclude Records With Profanity
Exclude by Genre
In Genres To Exclude, you can add genres you want excluded from your Aspen catalog. Add these one on each line. These are genres as defined by hoopla.
You'll also want to go toAspen Administration>Primary Configuration>Library Systems>Hoopla(toward the bottom) and make sure the correct scope is selected from the dropdown.
See How Hoopla Records Are Cataloged
To see the data that Aspen is receiving from Hoopla, you can click into a Hoopla record in Aspen, then open the Staff View to see the Hoopla Extract Information. You will see the various data points that correspond to the scope such as:
[abridged]
[profanity]
[genres]
[price]
[kind]
Note: Changes to scopes will take an overnight index to appear.
For single libraries, Aspen will honor the individual titles that are blocked on the Hoopla Administration portal and not load them into the catalog.
For library consortiums, Aspen will honor the individual titles that are blocked on the Hoopla Administration portal of the Hoopla ID defined in the Hoopla Settings and not load them into any of the Aspen catalogs. Because Aspen can only put one Hoopla ID in the settings, you may choose the most restrictive library Hoopla ID or the library that actively blocks titles in Hoopla.
Currently, you can load Hoopla Flex titles as a Side Load.
Once side loaded, users will be able to narrow down by Hoopla Flex titles. The eContent Collection facet will include any econtent collections that are loaded into Aspen via the API and via side load.
When the titles are added, Aspen will search for like titles, authors, and expressions of the work to group with.
Because the titles are side loaded, the user will manage the Hoopla Flex checkout via Hoopla's site. Hoopla titles coming in via the API can all be directly managed within Aspen.
Once loaded, titles will show and group with other physical and econtent you have loaded. From the grouped work display users can check out from Hoopla.
My Account
Checked out titles from hoopla will show inMy Account>Checked Out Titleswith the rest of the user's physical and electronic items.
This information is synced across platforms so anything checked out directly from the hoopla site, app or Aspen by this user will all show here in one place.
Account Settings
InMy Account>Account Settings>Hoopla Options there is an option to control the email address that alerts users about checkouts placed through Aspen on Hoopla items.
This option relates to the pop up that asks the user if they are sure if they want to use one of their X amount of checkouts a month on that title that pops up when they check out an item in Aspen.
If a user has never used Hoopla before then they will still need to register their account via Hoopla before they can make checkouts in Aspen. If they attempt to check something out via Aspen, they will get an error that says "We are unable to find a hoopla digital account for {library card number}. Please register at https://www.hoopladigital.com/register."
Once the user registers in Hoopla, usually by selecting their library, putting in their library card number (and sometimes pin) and registering their email address, the connection with Aspen is almost immediate.
When the user clicks Check Out in Aspen, they will see how many checkouts they have left.
Then, once they click Check Out, they will see a successful checkout and how many more titles they have available to borrow this month.
Titles checked out in Aspen also show up pretty simultaneously within the Hoopla site.
If you already have hoopla set up in Aspen and decide to remove the hoopla integration from Aspen:
Go to Aspen Administration > hoopla > Scopes > click into the corresponding scope > uncheck the corresponding Libraries and Locations > Save
Next, go to Aspen Administration > hoopla > Settings > click into the setting > check Run Full Update > Save
It will take an overnight index to remove the records from the catalog(s).
The next day, check to make sure all the records are removed from the catalog(s).
You can go back to Aspen Administration > hoopla > Scopesand completely Delete any scopes that will no longer be in use.
Finally, go to Aspen Administration > Primary Configuration > Library Systems > click into the corresponding library system > scroll to the bottom to the hoopla settings. Clear out the Hoopla Library ID and In Hoopla Scope > make sure None is selected > Save.
If you are completely removing hoopla from your server/all catalogs then you can additionally go to hoopla > Settings and delete the setting. Then, go to System Administration > Modules > hoopla > uncheck Enabled? and Save. This will remove the settings from the Administration area.
To begin, you'll need to fill out OverDrive's Developer Application to submit to OverDrive in order to get your API credentials. Even if you already have an API connection with OverDrive, they will need this form to allow your account access to your new discovery layer. Keep in mind that it can sometimes take 7-14 business days to receive your credentials.
Note: If you do not currently have your existing Client Secret on record, you will need to request them to reset this for you as well. Having your secret reset will impact any other vendors you're using with the OverDrive API (ex: your existing OPAC/ILS, library apps like Communico, etc). OverDrive confirms with you that this will be the case prior to making any changes so there is an opportunity to coordinate with other vendors before the changes are applied. If you have questions about this, please ask your OverDrive support representative.
To add Libby, turn the module on inAspen Administration > System Administration > Modules.
Once enabled, a new Libby menu will appear in Aspen Administration.
In Libby >Settingsyou will need:
Your OverDrive URL - exp: https://{library}.overdrive.com
Patron API URL - http://patron.api.overdrive.com
Client Key
Client Secret
Account ID
Website ID
Products Key
When your API application is approved, OverDrive will send you the above credentials. You can email your Implementation Specialist or follow the steps below:
1. Enter the OverDrive URL, Patron API URL, Client Key, Client Secret, Account ID, and Website ID and Save.
2. Make sure the boxes are checked for Enable updated checkout fulfillment interface and Show Libby promo in checkout fulfillment interface.
3. In Libby> API Information, click Library Account Information to expand and find the Products Key in [collectionToken]. Copy and paste this into Libby > Settings > Products Key.
4. Next, go toLibby>Scopes. If you're setting up for a single library system, edit the existing scope and apply the settings to your library/locations. If you have multiple libraries with their own accounts, you can create new scopes and apply them to certain libraries and/or locations. If you need help with this, please reach out to Aspen support.
Note: for the setting "is a PIN Required to log into OverDrive website?" confirm what is asked for on your current OverDrive digital website. If the site only asks for the library card number, make sure this setting is unchecked.
5. If you have an Advantage account, go to Libby > API Information to find your Advantage credentials. There may be multiple Advantage accounts listed, and they are not in alphabetical order, so using CTRL+F to search for your library can be helpful. Find your library, then copy and paste the exact library name (as shown) into Libby > Scopes > OverDrive Advantage Name, and copy and paste in the OverDrive Advantage Products Key.
6. In Reader Name, enter Libby, unless you'd like to have collections display as something like 'Libby/OverDrive' or 'OverDrive' instead.
7. Go toAspen Administration>Primary Configuration>Library Systems> Libby(toward the bottom) and make sure the correct scope is selected from the dropdown menu.
If you are also changing vendors for your ILS during your Aspen implementation, it is imperative that you let OverDrive know you are switching ILSes. Make sure you have the correct SIP connections set up with your new ILS for OverDrive authentication for your go live day. The Libby collections are pulled in through the API, but the authentication of the users to check if they are an active patron in good standing take places through the ILS/SIP.
To view your options, go toAspen Administration>Libby>Scopes>click into your existing scopeorAdd New
A common use for scoping this content is for a seperate kid's catalog. Then, the library can show off their full collections in their main catalog and only show off their kid's or teens materials in their other catalog.
The options are:
Include Adult Titles
Include Teen Titles
Include Kids Titles
For Libby titles Aspen looks at subjects:
If subjects indicate Juvenile, then the audience is Juvenile and is included in the Include Kids Titles.
If the subjects indicate Young Adult or YA, then the audience is Young Adult and is included in the Include Teen Titles.
If those don't exist, it assumes Adult and it is not included in the Include Kids Titles.
This data count be found within the detailed record page > Staff View.
These settings take a Nightly Index to fully update.
If you have an Advantage Account, that information will be shared via the API once we put in your credentials and we will set those up for you. With libraries with separate scoped catalogs, that means each catalog can highlight shared collections and Advantage Collections only available to their patrons.
Aspen doesn't make any specific API calls to look for Cost Per Circ titles. Within the incremental updates in the Libby > Indexing Log, it will see if a title is available or not and update the record availability based off of that.
The checkouts of the Cost Per Circ titles will be handled on the backend of OverDrive.
Kanopy was purchased by OverDrive but titles are not included in the Libby API at this time. This would be an enhancement request to OverDrive to develop. Currently, Kanopy titles can be sideloaded into Aspen. Kanopy and Kanopy - Premium MARC records are available by request from the vendor. For Kanopy titles available via Subsciption and/or Bundles, check your Kanopy staff interface to see if titles are available for download. See their Help Documentation to learn more.
If you are school or public library you might have a product called Sora instead of Libby. We can load titles from the API via filling up the set up application above.
The biggest difference we see with this set up is that the authorization of the check out takes place outside of Aspen, usually through the student's school email address. In this case, there will be an Access Online button instead of a Check Out or Place Hold button in Aspen.
Once loaded, titles will show and group with other physical and econtent you have loaded. From the grouped work display users can check out from Libby.
Users will also have the option to Preview Libby titles - both from eBooks and eAudiobooks. Sometimes there are mutliple previews available if there are different versions/editions/length of clips.
In this grouped work display, there is an eBook format and a Kindle format. These are the same record but Aspen purposely splits these out. eBook is equivalent to Adobe EPUB or Libby Read versions. Kindle is split out because patrons often recognize the need for that specific compatible version. The name Kindle is much more identifiable to users than EPUB.
My Account
Checked out titles from Libby will show in My Account > Checked Out Titles with the rest of the user's physical and electronic items.
Titles on Hold from OverDrive/Libby will show in My Account > Titleson Hold with the rest of the user's physical and electronic holds.
This information is synced across platforms, so anything checked out directly from the OverDrive site, Libby app, or Aspen by this user will all show here in one place.
When users sign into Aspen for the first time, any existing checkouts/holds from the Libby app or OverDrive site should load into their Aspen account. Likewise, any holds or checkouts place on Libby items from Aspen should show up in the Libby app/OverDrive site.
Account Settings
InMy Account>Account Settings>Libby Options there are some options related to OverDrive/Libby checkouts/holds through Aspen.
These are settings related to the email address and loan periods related to activty of items within Aspen.
This is for users who may not want to have to log into OverDrive/Libby to make those changes and who use Aspen primarliy for all of their account activity.
As of June 2024, Kindle titles can no longer be returned via the Libby app or any product using the OverDrive APIs.
Titles checked out and sent to a Kindle device will need to be returned via the user's Amazon account. There will be no "Return Early" button in Aspen for titles checked out on Kindle.
Sorry, but we could not place a hold for you on this title. Invalid 'emailAddress' format
If a user sees the above error when trying to place a hold on a Libby title, follow these steps.
In the user account, go to Your Account > Account Settings > Libby Options.
In the Libby Hold email field, check carefully to see if there are any spaces or if someone accidentally entered something besides a valid email address.
Fix any mistakes and click Save. The user should now be able to place holds.
In this example screenshot, there are extra spaces in the email causing errors.
To enable the Palace Project module, go to Aspen Administration > System Administration > Modules > find and edit 'Palace Project' > check the box for 'Enabled?'
Check Permissions
To administer Palace Project settings, you will need the following permissions:
Administer Palace Project: Allows the user to configure Palace Project integration for all libraries.
Create Settings
From Aspen administration, head to Palace Project > Settings > click Add New.
You will need to enter in the following credentials:
Palace Project URL
Library ID/short name
If you have access to your Palace Collection Manager, you can simply navigate to it and login to find your credentials. After logging in, the information you need will be available in the URL bar.
The library ID/short name is also listed in the URL bar and is your IMLS FSCS ID (so for example VT1234).
If you do not have access to your Palace Collection Manager, can't remember how to login, or need assistance assembling this information, you can reach out to the Palace Project support team atsupport@thepalaceproject.org
Once your credentials are entered in, add any additional information for users in the Instructions For Using Palace Project text box.
The Default tab is the text that would display for any user interface. If you'd like to translate this text into other languages that have been added to your interface, click the additional tabs to do so. You can click the Copy From Default button to copy over the base text. Any formatting or images used will come over as well, so all you'll need to do is translate the text.
Save your changes when finished.
Define the Scope
Once the Palace Project setting is saved, Aspen will automatically create a corresponding Scope setting in Palace Project > Scopes.
In order for Palace Project content to display in search results, you must edit the scope and select the Libraries and Locations that should have access to this content.
Once the scope is saved with the applicable libraries and locations selected, content will begin to appear in search results as the records index.
As of the 24.04 release, Aspen now has the ability to scope Palace Project by age/audience.
To view your options, go toAspen Administration> Palace Project>Scopes>click into your existing scopeorAdd New
A common use for scoping this content is for a separate children's catalog. By using this audience scoping, the library can show off their full collection in the main catalog and only show off their kid's or teens materials in the children's catalog.
The options are:
Include Adult Titles
Include Teen Titles
Include Kids Titles
Aspen uses audience data via the API to determine these categories:
If there are indicators of Children, then the audience will be Juvenile and will show in the "Include Kids Titles" option
If there are indicators of Young Adult, then the audience will be Young Adult and will show in the "Include Teen Titles" option
If there are indicators of Adult, then the audience will be Adult and will show in the "Include Adult Titles" option
This data count be found within the detailed record page > Staff View.
These settings take a Nightly Index to fully update.
Aspen will automatically pull in all Palace Project Collections into Aspen Administration > Palace Project > Settings > Collections.
In the Aspen Display Name, you can update how this collection appears in facets and search results.
You can also decide if that specific collection Has Circulation (check outs and holds via Aspen) and/or if you want to Include in Aspen to add/remove collections.
These settings take a Nightly Index to fully update.
Users will be able to discover Palace Project content along with any other content in the catalog search results.
Users can also browse Palace Project collections within the eContent Collection facet.
My Account
Checked out titles from Palace Project will show in Your Account > Checked Out Titles with the rest of the user's physical and electronic items. Clicking the Palace Project tab will filter just to those items.
Checking out Palace Project Titles
When users click Palace Project Instructions, a new modal window will appear with instructions for downloading the Palace Project app. These instructions can be modified by an Aspen administrator in the Palace Project settings.
Aspen integrates with a number of different econtent providers. There are corresponding reporting Dashboards for Boundless (formerly Axis360), CloudLibrary, EBSCOhost and EDS, Hoopla, and Libby. What's important to remember with these reports is that these just track user interactions with the econtent platforms done through Aspen. For full econtent reporting, you'd still want to check the data available within your econtent provider's reporting dashboards.
These econtent dashboards have similar data offerings, including:
Active Users- Users within Aspen that have had successful check out or placed a successful hold
Records With Usage- Records with usage is total number of unique titles that have been checked out or placed on hold. So that number should be less than the number of holds and loans combined.
Loans- All successful checkouts in Aspen
Renewals- Number of successful renewals in Aspen. Because a renewal is essentially a hold, some of those (the holds that were fulfilled and accessed via Aspen) are included in all time loans.
Downloads-Downloads is the number of times the download button was clicked. So, if you have a user that isusing Aspen to access the read onlineversion, there would be one click for each time they opened the book OR if a user downloaded a title on one device but then needed it downloaded on another, that would result in 2 downloads for the same title.
Options Updates-Updating their user preferences in Aspen's My Account
API Errors- Anytime there isan error back when accessing a record; like when placing a hold or checking out and user receives an error; if you're noticing a lot of them, let us know; we're not automatically monitoring these
Connection Failures- OverDrive entire APIs are down; should be zero for everyone
Wondering how to integrate eContent from vendors other than those listed on this page? We've put together a directory of vendors libraries have asked about and how you can add or promote them in Aspen.
This list is not all-inclusive. The general rule of thumb is: if Aspen cannot integrate with a vendor via API (only the eContent outlined in previous sections on this page), then your options are:
In Masquerade Mode, staff can help patrons view their econtent checkouts and holds, as well as help with other econtent functionality - like checking out titles, placing titles on hold, seeing hold queue position and returning titles early.
To use Masquerade Mode to assist with eContent, users must log into Aspen Discovery at least once. For example, if patrons only log into apps like Libby and not directly into the catalog, you might want to check with them if staff are having issues with the patron's account in Masquerade Mode.
Similarly, even if the patron has logged in before, if it has been a while and they have changed their password since the last time, they might need to log into Aspen Discovery again before staff can assist patrons in Masquerade Mode.
The logging in by a patron is what authorizing the connection between the ILS, the econtent provider and Aspen Discovery/LiDA.
Logging in by the patron should almost immediately correct any errors you might have been seeing.