This page contains the last of three steps in the documentation for setting up the RapidILL OAI Holdings process. An overview of the process in its entirety can be found here.
If a significant portion of your physical titles do not have items, please see: Holdings Without Items documentation.
Using Out of the Box Publishing Profiles
A publishing profile needs to be created for each set created in Step 2. We strongly recommend using the out of the box publishing profiles, as they are pre-configured with the proper Set Spec and Item/Inventory Enrichment.
These template publishing profiles are available in the Community Zone. To localize the profiles and activate them in your institution, follow these steps:
Navigate to Resources > Publishing > Publishing Profiles.
Go to the Community tab and search for “EXL” in the description. (The search is case-sensitive. Be sure to use capital letters - EXL, not exl.) You’ll find the 12 publishing profiles published by Alma University.
For each of the profiles:
Create a local copy of each relevant profile using the Copy row action.
In the Publishing Profile Details page:
In Publishing Parameters section, set Status to active.
Set the scheduling parameter to execute the publishing job to run weekly per your preferred schedule.
In the Content section, select the appropriate set name you defined when creating the sets.
Save the profile.
Using Other Publishing Profiles
We strongly recommend using the out of the box publishing profiles, as they are pre-configured with the proper Set Spec and Item/Inventory Enrichment. However, if you don’t wish to use the out of the box publishing profile, please make sure these guidelines are followed in addition to those mentioned in the previous section:
- Content Type = Bibliographic.
- The Set Spec field should be filled in the following template:
Rapid_[branch if relevant]_[Holding Type]_[Holding Format]_[Lendable Status]
Example: Rapid_ILLUV_Books_Print_LendableInternationalThe appropriate lendable status (LendableInternational / LendableCountry / LocalOnly) must be included in the Set Spec exactly. Rapid looks for this string to determine the lendable status of a set.
- Publish on = Bibliographic level.
- Publishing Protocol = OAI.
- The Data Enrichment tab should be filled as such:
Holdings Format Enrichment Screenshot Under the Physical Items Enrichment section, check “Add Items Information”.
Repeatable field = 954
Description subfield = m
Current library subfield = q
Current location subfield = rCall number subfield = t
Electronic Under the Electronic Inventory Enrichment section, check “Add Electronic Portfolio Information”.
Repeatable field = 949
Access URL subfield = u
Link Resolver Base URL – see below.
Coverage Statement subfield = eCollection Name subfield = aYou may add other enrichments using other letters, but they are not needed for RapidILL holdings.
Additional Configuration Needed for Electronic Publishing Profiles
For electronic inventory profiles, in the Data Enrichment tab, find the Link Resolver Base URL field. This field will need to be filled differently for Primo and PrimoVE customers:
- For Primo, use the following format and insert your institution’s information where indicated:
https://[Primo server host:port]/openurl/[Primo_institution_code]/[Primo_view_code]?
For example: http://demo.alma.exlibrisgroup.com:1701/openurl/EXLDEV1_INST/Alma2?
- For PrimoVE, use the following format:
For example: https://na02.alma.exlibrisgroup.com/discovery/openurl?institution=EXLDEV1_INST&vid=EXLDEV1_INST:Alma&
Do not change other values in the data enrichment tab. They are important for proper mapping in RapidILL.
Publishing for the First Time
After a publishing profile is created, the job is scheduled to run incrementally once a week.
The first time the job is run, it must be run in full mode. To run in full mode, proceed as follows:
- Go to Alma Configuration > Resources > Publishing > Publishing Profiles.
- Under the institution tab, search for the “RapidILL” profiles. Make sure the Publishing Profile Type is set to All.
- Select Republish from the row action.
- Select the Rebuild Entire Index option and click Run Now.
Republish profile after scheduling
Testing Your Sets
This step isn't mandatory, but many customers find it helpful. Performing this test requires that your OAI integration profile (see Step 1: Creating the OAI Integration Profile) allows access to your IP.
Test your sets by building a ListSets URL. This helps you to make sure your sets were created successfully.
- Template: https://[AlmaBaseURL]/view/oai/[institutioncode]/request?verb=ListSets
- For example: https://na02.alma.exlibrisgroup.com/...?verb=ListSets
You should see a list of all sets Alma is publishing through OAI.
To test a specific set, you can use another link:
For example: https://na02.alma.exlibrisgroup.com/...1_INST/request? verb=ListRecords&metadataPrefix=marc21&set=Rapid_Journals_Print_LendableCountry
You should be able to see the first 200 records or so. It’s important to check that they have the 954 (print) or 949 (electronic) fields.
Additional OAI Setup Options
While the above instructions cover most institution's needs, there have been a few repeated cases that may be useful during setup.
How to include electronic collections from a network zone level - If you have electronic collections managed at the network zone level you can send these to RapidILL in addition to collections held at the institution zone level.
Starting the RapidILL Holdings Process
When you have finished scheduling publishing profiles, please let the RapidILL team know by creating a ticket. We will then configure RapidILL accordingly and process the data. Follow up on your holdings by checking the Holding Status Page.
Entries are only displayed after data has been updated into RapidILL.