Configuring Central Index and Proxy Settings for Primo VE

Introduction

The Central Discovery Index (CDI), which is also referred to as the Central Index, is a centralized index that encompasses hundreds of millions of records of global or regional significance that are harvested from primary and secondary publishers and aggregators. These records include a mix of scholarly material – primarily articles and e-books – but also conference proceedings, newspaper articles, and more. In addition to citation metadata, many records include abstracts and some also include full text. The full text in CDI is indexed and used for discovery, not for delivery. For information on how to register for CDI, see Enabling the Central Index.

This document includes the following sections, which show how to enable the Central Index and configure additional settings associated with the CDI.

Enabling the Central Index
Enabling the Central Index for Environments with Distributed Access to Electronic Resources
Configuring a View to Search the Central Index

For information on how to publish holdings to CDI, see Publishing to Central Discovery Index.

Enabling the Central Index

This section describes how to enable CDI and additional configurations (such as proxies and controlled vocabularies) for environments that do not support distributed access to electronic resources between campuses and libraries.

For institutions with a multi-campus configuration, see Enabling the Central Index for Environments with Distributed Access to Electronic Resources.

To configure the Central index and proxy settings:

If you have not already done so, register your institution on the Central Index and Proxy set-up page (Configuration Menu > Discovery > Other > Central Index and proxy set-up). For more details, see Registering Institutions for Central Discovery Index.

Central Index and Proxy Set-Up Page

After you receive an approval email (which can take up to several days), re-edit the page and specify the following fields:

CDI Configuration Fields
Field	Description
Registration:
CDI Key	Enter the CDI Key that you received in your Central Index registration email. If you have not registered with the Central Index service, select Register to Central Discovery Index and follow the registration instructions. This field is required. After you save your CDI Key and Customer ID, the View my Profile link replaces the Registration link, enabling you to modify your customer and contact details, unsubscribe institutions, and configure your client applications. For more information, see My Profile for CDI. View my Profile Link
Customer ID	Enter the customer ID that you received in your Central Index approval email. This field is required.
Member Code	When multiple institutions share a Network Zone, or a single institution uses a multi-campus set-up, this code can be added to identify which library holds resources. For additional information, see Central Publishing in the Network.
Email	A contact email in case there is an issue with the registration
Search Configurations:
Newspaper search	When selected, this option enables the Newspaper Search feature for the entire institution. Once enabled, you can configure various options for each view. For more information, see Configuring Discovery Views for Primo VE.
Use Proxy:
CDI Proxy	If you want to enable off-campus users to access full text services at different vendor sites, you must select a resolver proxy profile from the drop-down list. If you have not cot configured a proxy, select Proxy Configuration. For more details on configuring a proxy, see Resolver Proxies.
Use proxy only if the user is off-campus	Select this checkbox if you want to use the selected proxy when the user is off-campus only. Users are considered off-campus if they are not signed-in and not within the defined IP range for the institution. For more details, see Configuring IP Ranges for a Library. This setting takes precedence over the Use proxy for CDI links setting. Thus, when Use proxy for CDI links is set to On or Selective, and Use proxy only if the user is off-campus is selected, CDI links are not proxied when the user is on campus.
Do not proxy Open Access records	Select this checkbox if you do not want to use the selected proxy for Open Access records (including Quicklinks). This setting takes precedence over the Use proxy for CDI links setting. Thus, when Use proxy for CDI links is set to On or Selective, and Do not proxy Open Access records is selected, Open Access links are not proxied. For more details about Open Access, see Open Access Content in CDI.
Use proxy for CDI links	Select when to use the selected proxy for direct links in CDI records. On – Proxy is used for all direct links in CDI records. Off – Proxy is not used. Selective - Use of the proxy depends on Alma collection-level proxy settings, which are defined in the settings of each collection (in the Electronic Collection Editor, Additional tab). For additional information, see Configuring Selective Proxy Settings on the Collection Level for CDI Linking, below.
Featured Newspapers:
Add New Featured Newspaper	The Featured Newspapers functionality enables you to define featured categories from which users can search to find newspapers that you want to make more prominent. These categories appear in the Newspaper Search box and in the Featured Newspaper section on the Newspaper Search page. To add a featured category, select Add New Featured Newspaper and specify the following fields in the dialog box to create a category of newspaper articles to display in the Featured Newspapers section on the Newspaper Search page: Code – Specify the code name for the category's description. The display label for the description is defined with the Newspapers Search code table. Name – Specify the code name for the category. The display label for the category is defined with the Newspapers Search code table. ISSN – Specify the ISSN of the newspaper. You can specify a maximum of five ISSNs per category by separating them with a semicolon. For example: 0362-4331;1085-6706. Description – An optional description to internally document the category. You can define a maximum of five categories per view (including disabled categories).
Provider preference order for CDI linking: You do not need to add precedence for all providers, but the providers in this list have precedence over providers that are not included in this list.
Add new provider	This section allows you to configure which providers are given preference when displaying links from CDI in View It. These preferences are used in the following situations: When only a single link is returned from CDI, regardless of the setting of the Display All Links from CDI option. When the Display All Links from CDI option is enabled and multiple links are returned from CDI. The linking preferences apply to both general Link in Record links and Quicklinks and All links. This configuration is passed to CDI and is used when returning search results from CDI. For more information regarding link priority, see CDI and Linking to Electronic Full Text. To add providers to the preference list: Select Add new provider to open the configuration dialog box. In the Provider Name field, select the provider to which you want to give precedence. This drop-down includes all CDI providers that have Provider Coverage set to Yes in the CDI Collection List. Select either Add to bottom or Add to top to indicate whether the selected provider has more or less precedence than other providers that you add to the list. Select the arrow in the Move Up/Move Down columns to adjust the new provider's precedence. Repeat the above steps for additional providers.

Select Save.

Enabling the Central Index for Environments with Distributed Access to Electronic Resources

In Alma, electronic resources can be managed at the campus/library level. If there are significant differences between campuses/libraries in terms of electronic resource subscriptions, you should create a separate view and a Central Index (CDI) profile for each campus/library defined for your institution. This ensures that the availability of full text is relative to each campus/library.

The system uses the default CDI profile if the view that the patron is using is not affiliated with a library/campus.

For details on how to configure distributed access environments, see the following documents:

To configure multiple CDI profiles:

On the Central Index and Proxy set-up page (Configuration Menu > Discovery > Other > Central Index and proxy set-up), select Add Library or Add Campus to open the Add Library dialog box or the Add Campus dialog box, respectively.

Add Campus Dialog Box
Select the library/campus for which you want to create a separate CDI profile. The library/campus must be defined before you can create a separate CDI profile for it.

Add Campus Dialog Box
Select Add and Close to return to the Central Index and Proxy List page.
Edit the new CDI profile. Refer to the CDI Configuration Fields table to fill in the fields.

Each CDI profile must be configured with its own CDI Key to enable separate holdings files to be maintained for each campus.
Save your changes to the profile.
After you have added a CDI profile for each library/campus, select a default CDI profile by enabling its Default slider on the Central Index and Proxy List page.

Setting the Default CDI Profile

The system uses the default CDI profile if the view that the patron is using is not affiliated with a library/campus. You can define only one default for an institution. For example:

View Configured with No Affiliation

Configuring a View to Search the Central Index

After you configure the Central Index, your view must have a slot that includes the Central Index search scope. Out-of-the-box, the CentralIndex search profile includes only the Central Index search scope.

To enable patrons to search the Central Index:

Configure all search profiles that include the Central Index search scope:
1. Open the Search Profiles page (Configuration Menu > Discovery > Search Configuration > Search Profiles), and select the Search Profiles tab. For more details, see Configuring Search Profiles for Primo VE.
  
  Search Profiles Page
2. Edit each search Profile row that includes the Central Index scope to open the Define a Custom Search Profile page. Out-of-the-box, the CentralIndex and MyInst_and_Cl search profiles include the Central Index scope.
  
  Define a Custom Search Profile Page
3. Select the Filter by Availability checkbox if you want to display only CDI records that have full text. Otherwise, the system will display all matching CDI records.
4. If the search profile blends the Central Index search scope and a local/other search scope, see Boosting Records in Blended Search Profiles to configure its boost settings.
5. Select Save to save your changes to the Define a Custom Search Profile page.
Configure your view to use a search profile that includes the Central Index search scope.
1. Open the View List page (Configuration Menu > Discovery > Display Configuration > Configure Views). For more information, see Configuring Discovery Views for Primo VE.
2. Edit your view, and then select the Search Profile Slots tab.
  
  View Configuration Page - Search Profile Slot Tab
3. Edit an existing slot or select Add a Slot to create a slot to which you want to include the Central Index search scope. Out-of-the-box, the Central Index search scope is enabled in the Everything and CentralIndex slots.
  
  Edit Profile Slot Page
4. From the list of search profiles, activate a search profile that contains the Central Index scope.
5. Select Save to save your changes and return to the Search Profile Slots tab.
  
  Activate Profile Slot
6. Activate the profile slot.

Configuring Selective Proxy-Settings on the Collection Level for CDI Linking

Proxy settings can be configured on the collection level for CDI linking – including Link in Record links, Quicklinks, and Document Insights links. This selective application of proxy settings per collection allows libraries to apply authentication (e.g., EZproxy, OpenAthens) only to specific electronic collections that require it.

Selective proxy-settings are configured in the proxy settings of the collection in Alma (Proxy enabled – Yes or No), which are passed to CDI during CDI publishing (see Publishing to Central Discovery Index). When a link is sent by CDI to Primo VE, the proxy setting is included in the PNX of the link. Then, if selective application of proxy settings is activated in Primo VE, Primo VE uses the PNX information to either proxy or not proxy the link, as specified.

Proxy settings can also be defined via the Alma LinkResolver at the collection level for CDI collections that link to full text.
Alma also enables you to apply selective proxy-settings on the service and portfolio levels, and to use different proxies per campus or library. This functionality is not available for CDI links. CDI only supports collection-level proxy settings from Alma and only one proxy setting per collection and per CDI holdings file/PCkey.

Setting Up the Proxy Settings in Alma

Before you activate the selective proxy-setting option in Primo VE, ensure that the proxy settings for each active collection correctly specify whether the proxy should or should not be used for it. This is defined in the Electronic Collection Editor, in the Additional tab. (To open the editor, in the row actions of the collection, select Edit Collection.) For additional information, see the Alma documentation about proxy settings: Managing Electronic Resources; Access to Services.

Alma Electronic Collection Editor settings in the Additional tab, with "Proxy enabled" selected.

Proxy Setting in the Collection Configuration in Alma

If you make changes to the proxy settings for a collection, the changes will take effect only with the next CDI-rights update (as with newly activated collections).

Activating the Selective Proxy-Setting in Primo VE

When the selective proxy option is activated in Primo VE, Primo VE checks the proxy setting in the PNX of each CDI collection it handles, and implements the setting.

To activate the selective-proxy option:

In Configuration Menu > Discovery > Other > Central Index and proxy set-up, under Use proxy for CDI links, select Selective.

Use Proxy for CDI Links Field

The settings under Proxy Settings – Use proxy only if the user is off-campus and Do not proxy Open Access records – take precedence over the Use proxy for CDI links setting. Thus, when Use proxy for CDI links is set to On or Selective, if Use proxy only if the user is off-campus is selected, CDI links are not proxied when the user is on campus, and if Do not proxy Open Access records is selected, Open Access CDI links are not proxied.

PNX Support

A $$P parameter is included in all CDI links (linktorsrc, linktorsrcadditional, linktohtml, linktopdf, linkunpaywall, docinsights, backlink). Possible values are:

omit_proxy_false – The Alma Collection proxy setting should be checked.
omit_proxy_true – The Alma Collection proxy setting should not be checked.

Example:

<links>

<linktorsrc>$$Uhttps://data.europeana.eu/item/352/_filmportal_de_node_1740105$$EView_record_in_Europeana$$FView_record_in_$$GEuropeana$$Hfree_for_read$$Pomit_proxy_false</linktorsrc>

<linktohtml>$$Uhttps://data.europeana.eu/item/352/_filmportal_de_node_1740105$$EHTML$$P50$$Geuropeana$$Hfree_for_read$$Pomit_proxy_false</linktohtml>

</links>