Learn how interact with certain CapiraMobile features if Koha is your connected ILS.
Overview
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.
Note: Some features may differ depending on your integration version. Please check with your ILS administrator to confirm which Koha integration you are using.
Carousels
More information coming soon.
Enhanced metadata display fields
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 Koha:
- Edition
- Call Number
- ISBN(s)
- UPS/ISXN
Hold options
The features below are allowed by the ILS, but may vary depending on your library's implementation.
- Cancel a hold
- Display position in holds queue to patrons
Note: Does not allow for modifying holds.
Search filters
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.
- The default search material/format used if no option is provided or none is selected by a user is All Materials.
- The default search library/location used if no option is provided or none is selected by a user is All Libraries/Scopes.
- The default search index used if no option is provided or none is selected by a user is Keyword/Everything.
- The default sort options used if no option is provided or none is selected by a user is dependent on your ILS, but it is usually Relevancy.
- The default audience used if no option is provided or none is selected by a user is dependent on your ILS, but it is usually All Audiences.
- The default collection used if no option is provided or none is selected by a user is dependent on your ILS, but it is usually Everything.
Search filter examples
These apply to libraries running Koha. To learn how to add a filter, see Search filters.
- Koha filter examples
-
Material/Format 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.
| Material |
Old value |
New value |
| Books |
Books |
BOOK |
| Audiobooks |
Audiobooks |
AUDIOBOOKS |
| DVDs |
DVDs |
DVD |
| Large Print |
Large Print |
LARGE PRINT |
-
Index filters
These filters are typically the same index 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.
| Example display name |
Old value |
New value |
| Index |
- |
ISBN |
| ISBN |
- |
TITLE |
| Title |
- |
AUTHOR |
Sort filters
The Koha REST API does not support sort options at this time.
Audience filters
These filters are typically the same audience 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.
| Audience |
Old value |
New value |
| Adult |
Adult books |
Not supported |
| Teen |
Teen |
Not supported |
| Juvenile |
Juvenile Materials |
Not supported |
Collection filters
These filters are typically the same collection 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.
| Collection |
Old value |
New value |
| Book Club |
BCLUB |
Stays the same |
| Biography |
BIO |
Stays the same |
| Compact Disc Music |
CD |
Stays the same |
Library filters
These filters may vary based on how each library system chooses to configure their Bibliographic Locations Codes.
