Improving Alma/Primo VE linking with Unpaywall

Unpaywall via activating the Community Zone Unpaywall e-collection CZ Collection ID #615310000000000937 is quick to set up. This is the Alma preferred option. It can be used with Display Logic Rules and options to change the order of displayed links in Primo VE.  (Alma's Documentation on Unpaywall CZ Collection.)

Set Up Unpaywall Service

To activate Unpaywall as a GES, you will need one of the following roles: Fulfillment Administrator or General Systems Administrator.

1. Go to Alma Configuration Menu > Fulfillment > Discovery Interface Display Logic > General Electronic Services. The General Electronic Services Screen will open.
2. On the Institution tab, click on "Add Service."
   
3. Add the following to the Add Service pop up:
   Service Code: Unpaywall
   Service Name: Unpaywall
   Public Name: You may choose a public name. CARLI Recommendations: Look for Open Access version OR Open Access Full Text Available at Unpaywall
   Is this a Document Delivery/ILL service? Yes (This will reveal the Display Location field.)
   Display Location: Getit, viewit & How To Getit.
   URL Template: http://oadoi.org/{rft.doi}
   
4. Click the Add and Close button to complete the base service.

Add Service Availability Rules for When to Display Unpaywall link

Next, add Service Availability Rules to control when the Unpaywall service link is displayed or not in Primo VE. You may create any Service Availability Rules that you desire.  For example, you may not want the Unpaywall link to display for books, or for items without a DOI.  Steps for how to configure this example rule set are detailed below. 

1. Go to Alma Configuration Menu > Fulfillment > Discovery Interface Display Logic > General Electronic Services. The General Electronic Services Screen will open.
2. In the Unpaywall row, click on the ellipsis button and select "Edit."
   
3. The Service Details screen will open. Click on the Service Availability Rules tab. Then click the "Add Rule" link. The Edit Rule page will appear.
   
4. In the Edit rule section, add a descriptive Name for the rule. In this example, the rule name is: Do not display Unpaywall for book citations
5. In the Input Parameters section of the page, click the "Add Parameter" link.
6. In the Add Parameter pop-up screen that appears, use the drop-down options to choose the Name and Operator fields and then add the Value field. To not display Unpaywall for a book, the following are added:
   Name: rft.object_type
   Operator: =
   Value: BOOK
   
7. Click the "Add Parameter" button.
8. Change the Output Parameters IsDisplay to "False" so that the service will not display when the criteria are met.
   
9. Click "Save" at the top of the page and you will be returned to the Service Availability Rules list.
10. To add a second Rule, such as to not display the Unpaywall service if the item lacks a DOI, click the "Add Rule" link again. The Edit Rule page will appear.
11. In the Edit rule section, add a descriptive Name for the rule. In this example, the name is: Do not display Unpaywall if no DOI
12. In the Input Parameters section of the page, click the "Add Parameter" link.
13. In the Add Parameter pop-up screen, use the drop-down options to select the appropriate Name and Operator fields. To not display Unpaywall if there is no DOI, the following are added:
    Name: rft.doi
    Operator: Is empty
    
14. Click the "Add Parameter" button.
15. Change the Output Parameters IsDisplay to "False" so that the service will not display when the criteria are met.
16. Click the "Save" button at the top of the page and you will be returned to the Service Availability Rules list.
17. Since we set the two example Service Availability Rules to "IsDisplay=False" in Steps 8 and 15 above, we now need to change the Default general electronic services rule to IsDisplay=True. To do this, go to the Default rule section at the bottom of the Service Availability Rules page. Select the "Default general electronic services rule," click on the ellipsis button and select "Edit" to edit the rule.
18. In the Output Parameters section, set IsDisplay to "True."
19. Click "Save" at the top of the page.
    

To activate Unpaywall as a Link Resolver Service, you will need one of the following roles: Fulfillment Administrator or General Systems Administrator.

1. In Alma, go to Configuration menu > Fulfillment > General > Other Settings. A mapping table will open.
2. In the Mapping Table find the row: enable_open_access_services_from_unpaywall_api. Click on the ellipsis button to the right of the row and choose "Customize" to customize the item. The parameter value field will become editable.
   
3. Change the parameter value to: true
   
4. Click "Save" at the top of the page.

For more details about this parameter, please see the Other Settings Options section of this Ex Libris documentation Configuring Other Settings (Fulfillment).

Once you have customized the mapping table, you may test the change in Primo VE to view the Unpaywall links.

The default link text that will display in Primo VE is "Open Access full text available at: Unpaywall".  You may change this default prefix link text "Open Access full text available in:" by customizing the label in Alma Configuration > Discovery > Labels > ViewIt > c.uresolver.availableOnline.open_access_full_text_prefix.  Note that changing this label may apply to other open access full text services beyond Unpaywall.