Linking Parameters for CDI links

Some providers require specific configurations for the links in their collections to access their content. In these cases, special credentials should be added to the link to create a customer-specific URL.

For linkresolver linking, CDI users can configure these special customer linking parameters in SFX/ALMA, as explained here for Alma.

SFX Information about linking parameters can be found in the SFX General User’s Guide > KBManager > Linking parameters section and here.

For CDI Link in Record links, the configuration was done in Primo / Primo VE, using Templates as explained here.

Starting February 2024, CDI Quicklinks and Link in record links will be able to use the SFX/Alma customer linking parameters also in CDI Links, because they are now included in the Alma CDI publishing / SFX CDI export. This is supported for Collections with portfolios since February 2024, and for collections of type Database, since November 2024.
In Collections with portfolios, the Linking parameters used are those inserted in the collection's service, for the Link Resolver.
In Databases with out Service, the Linking parameters will be added on the collection level. This is new Alma feature since November 2024 release. See here for Alma Release notes.

The move will be gradual, as more and more collections will be changed to use the SFX/Alma customer linking parameters. In addition to this, CDI release notes are updated for any change of specific CDI collections which requires the linking parameter authentication to be configured.

Collections from Gale and ProQuest are prioritized. We encourage all customers who are subscribed to Gale and ProQuest collections to ensure their institution-specific customer linking parameters are configured on the SFX/Alma collection.

For ProQuest Databases: In general, the Client ID is not mandatory for linking, and links can work without it. However, it is best practice, and in some cases, specifically for OpenAthens customers, the parameter may be needed for smooth authentication. Customers can already populate the customer parameters.

For Gale Databases: The CDI links for Gale content require linking parameters, and currently, their linking is supported by templates as explained here. CDI will stop using the templates for Gale Databases and start using the Database linking parameters on March 1st, 2025. Customers are advised to check the Gale databases they are activated to and ensure they have the institution's linking parameters before this date to avoid any disruption.

The Linking Parameters on the service or the collection level can be updated also via e-inventory API: https://developers.exlibrisgroup.com/alma/apis/electronic/

Add linking Parameters in Collections with Portfolios

To add or edit linking parameters in Alma, you can use:

• The Activation Wizard during the initial activation.

• The Additional tab in the Electronic Collection Editor for database collections.

• The Linking tab in the Electronic Service Editor for selective/aggregator collections.

In this example, the collection is from Gale so the parameter is Gale one, LOC_ID, and the collection is an aggregator collection so the linking parameters are available in the Electronic Service Linking tab.

Or use the Electronic service editor (after activation), in the Linking Tab.

Adding the parameters now will not change how the links work in CDI, as this requires a change on Ex Libris' side. But inserting the parameters into collections now ensures that any change in CDI will not affect the users' experience and that linking will keep working.

Add Linking Parameters in Collections of Type Database

Adding linking parameters is not possible while activating the database, but it is possible by editing the database's parameters under the Authentication Parameters section on the Additional tab.

Notes

• When linking parameters are added to a Database, an indication will appear in the CZ updates task list.

• Only linking parameters defined in CZ can be used. It is not possible to add local linking parameters.

• For SFX/CDI customers, changes were made in the SFX December 2023 release to ensure that linking parameters are published to CDI and can be used for linking. If you have a local installation, please make sure that you have applied the December 2023 release Notes to ensure that the links will continue to work.

• Since the linking parameters are part of the Alma CDI publishing / SFX CDI export and the CDI activation processing, it may take some time for the CDI linking parameters to become available for users. For more information, see Managing Your Subscriptions and Free Content in CDI.