Purpose

This document provides help in creating a library collection in the Circulation Manager and connecting it to a library's catalog.

Provider Access Requirements

To ingest a library's Odilo collection data into the Library Simplified Circulation Manager, the library must obtain access to Odilo's catalog API. Staff from the library must contact Odilo and request access credentials (an API access account):

  • API Base URL: A web URL of the form https://[library_id].odilo.us/api/v2
  • Client Key: A secure encryption key supplied by Odilo
  • Client Secret: A passphrase for the encryption key supplied by Odilo

Once you have the proper client account information from Odilo, you can configure the collection in the Circulation Manager.

Configuring an Odilo Collection

  • Step 2   On the top menu bar, click the System Configuration (older versions, Configuration) option.


  • Step 3  Select Collections from the menu on the left and select Create a new collection

  • Step 4   Select RBDigital from the Protocol drop down field.

 

  • Step 5   Fill in the collection configuration form:

    • In the Name field, enter a unique collection name; in a multi-tenant environment, add the library name will be helpful (example: ABC Public Library Odilo Collection)

    • In the Library API base URL field, enter the URL for the library provided by Odilo

    • In the Client Key field, enter the value provided by Odilo

    • In the Client Secret field, enter the value provided by Odilo

    • To associate the collection with a library so the collection appears in its catalog, click the Add Library drop-down list and select the appropriate library name
    • Click the Add Library button which appears below the library selection
    • A box with two optional, but recommended, values appears; in order to display approximate wait times to patrons for holds/reservations they place on items in the collection, fill in the appropriate values for the library
      • Enter the default loan period in days
      • Enter default reservation period in days
    • Click the Submit button to save the collection

Enable the Odilo Collection Maintenance Scripts

A set of maintenance scripts which poll the Odilo catalog site for new book data are provided in the cron file for the Circulation Manager scripting container. However, they are not enabled by default. If this is the first library with an Odilo collection in the Circulation Manager, you must enable the maintenance scripts in order for the system to communicate with Odilo and download metadata for the library's collection.

 

Operational Note

If the Odilio maintenance scripts have been enabled previously, ingestion of the Odilo metadata for the library will begin at the next scheduled time after the collection record is saved.

 

 

All content on the LYRASIS Wiki is licensed under the CC BY (Attribution) license, unless otherwise noted.