Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated addon with new version; update description of the IdSuffix setting.

...

Name

Alma Primo Definitive Catalog Addon

Version

1.2.12

Author

Atlas Systems, Inc.

Description

Catalog Search and Import Addon that uses Alma as the catalog and Primo or Primo VE as the discovery layer.

Custom Fields Support

No

Download

View file
nameAlma Primo Definitive Catalog Search_v1.2.12.zip

Info

The addon is developed to support Alma Catalogs that use Primo or Primo VE as its discovery layer in Aeon, Ares, and ILLiad.

This addon is available for developers to modify and extend. Developers are encouraged to submit changes to this addon by forking the git repository from GitHub and creating a pull request.

...

Setting

Default

Type

Description

CatalogURL

String

The base URL that the query strings are appended to. The Catalog URL structure is {URL of the catalog}/primo-explore/ for Primo or {URL of the catalog}/discovery for Primo VE.

HomeURL

The Home URL structure is {URL of the catalog}/primo-explore/search?vid={4 Digit Primo Code} for Primo or {URL of the catalog}/discovery/search?vid={4 Digit Primo Code} for Primo VE.

AutoSearch

True

Boolean

Defines whether the search should be automatically performed when the form opens.

RemoveTrailingSpecialCharacters

True

Boolean

Defines whether to remove trailing special characters on import or not. The included special characters are " \/+,.;:-=.".

Examples: Baton Rouge, La., becomes Baton Rouge, La.

AvailableSearchTypes

Title, Author

String

The types of searches your catalog supports. The types in this list must each have a corresponding entry configured in DataMapping.SearchTypes.

SearchPriorityList

Title, Author

String

The fields that should be searched on, in order of search priority. Each field in the string will be checked for a valid corresponding search value in the request, and the first search type with a valid corresponding value will be used. Each search type must be separated by a comma. Each search type must have a corresponding value in the AvailableSearchTypes setting and configured in DataMapping.SearchTypes.

AutoRetrieveItems

True

Boolean

Defines whether or not the addon should automatically retrieve items related to a record being viewed. Disabling this setting can save the site on Alma API calls because it will only make a Retrieve Holdings List call when the button is pressed.

AlmaAPIURL

https://api-na.hosted.exlibrisgroup.com/almaws/v1/

String

The URL to the Alma API. The API URL is generally the same between sites. (ex. <https://api-na.hosted.exlibrisgroup.com/almaws/v1/)> More information can be found on Ex Libris' Site.

AlmaAPIKey

String

API key used for interacting with the Alma API.

PrimoSiteCode

String

The code that identifies the site in Primo Deep Links.

Ex: vid={PrimoSiteCode}.

IdSuffix

String

The last four digits of MMS IDs and IE IDs for your institution. This setting is required and should not be left blank.

Buttons

Back

Navigate back one page.

Forward

Navigate forward one page.

Stop

Stop loading the page.

Refresh

Refresh the page.

New Search

Goes to the home page of the catalog.

Search Buttons

Performs the specified search on the catalog using the contents of the specified field.

Retrieve Items

Retrieves the holding records for that item.

Note: This button will not appear when AutoRetrieveItems is enabled.

Import

Imports the selected record in the items grid.

...