Each ILS product offers different features with respect to APIs used by third parties like OCLC in order to get data. In addition, each library can often customize their ILS setup, which makes it difficult to have a one-size-fits-all guide for some features. For these reasons, OCLC is often unable to help configure this information directly and library staff will need to discuss available options and values with their ILS administrator and/or vendor.
To add a carousel to your app:
Note: You do not need to maintain the list; this is just an easy way to generate the JSON query language required to display Sierra carousels in CapiraMobile.
Some additional metadata fields are available to be enabled. These fields will display in the app's search results, not in an item's details. For more information, see Enhanced metadata display. The following additional fields can be enabled when using Innovative Sierra:
The features below are allowed by the ILS, but may vary depending on your library's implementation.
Libraries can choose to configure any filters if supported by their ILS. It is not mandatory to use all filters or groups configured in your ILS, which allows each library to determine their ideal setup for patrons.
If no search filter is chosen by a user, or no options are displayed, the default is ALL.
These apply to libraries running Innovative Sierra of any version who have access to Version 6 or higher of the Sierra REST API. The REST API key provided to OCLC requires the BIB READ, ITEM READ, and VOLUME READ permissions enabled at a minimum for Search/Item Details information. Information about the current version of the Sierra REST API installed on your system can be found at: https://<your-ils-hostname>/iii/sierra-api/about.
To learn how to add a filter, see Search filters.
These filters are typically the same material codes configured in your ILS for bibliographic records. You may need to consult your ILS administrator or vendor for a full list of these values.
Note: Multi-faceted material type filters are not supported.
Example display name | Value |
---|---|
Books | a |
DVDs | g |
Blu-Ray | b |
eBook | e |
VHS | z |
Playaway | q |
Video Game | s |
These are typically the same for all Innovative Sierra products and customers. You may use the table below as a complete reference.
Example display name | Value |
---|---|
Title | t |
Author | a |
Subject | d |
Note | n |
The Sierra REST API does not support sort options at this time.
The Sierra REST API does not support audience filter options at this time. Contact Innovative to request additional fixed-length field limits for API Search. See Sierra - More About the Advanced Word Search Index.
The Sierra REST API does not support collection filter options at this time. Contact Innovative to request additional fixed-length field limits for API Search. See Sierra - More About the Advanced Word Search Index.
These filters may vary based on how each library system chooses to configure their Bibliographic Location Codes. You may need to consult your ILS administrator or vendor for a full list of these values.
Note: If you would like to enter a string of codes into one location filter, please contact OCLC Support.
Example display name | Value |
---|---|
North Haven Public Library | nh |
Algoma Library | alg |
Cedar Point Library | cp |
Dowd Main Library | dml |
Dowd Branch Library | dbl |
Zenia Public Library | zp |