Customer Linking Parameters in CDI Links
Linking Parameters for CDI links
Some providers require specific configurations for the links in their collections to access their content. In these cases, unique credentials should be added to the link to create a customer-specific URL:
For link resolver linking, the unique customer linking parameters are configured in SFX and ALMA. For Alma configuration, see the Library-Specific Parameters Table section. For SFX configuration, see the Linking Parameters section in the SFX General User’s Guide and the Alma and SFX Linking Parser Parameters Guide.
For CDI Link in Record links, the unique customer linking parameters were used to be configured with Primo/Primo VE Templates. For details, see Special links configuration in CDI for Primo and Primo VE.
As of Feb 2024, CDI Quicklinks and Link in record links are able to use the SFX/Alma customer linking parameters. This is supported for Collections with portfolios and for collections of type Database.
In Collections with portfolios, the Linking parameters used are those inserted in the collection's service, for the Link Resolver.
In Databases without Service, the Linking parameters are added at the collection level. This is new Alma feature since November 2024 release. See here for Alma Release notes.
The move from Primo Templates to SFX/Alma customer parameters is gradual, as it requires testing and customers configurations.
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 LOC_ID, and the collection is an aggregator collection so the linking parameters are available in the Electronic Service Linking tab.
As part of the Activation Wizard
Or in the Electronic Service Editor (after activation), under the Linking Tab.
Override and Linking Parameter Requirement:
When a local override is applied to the service parser parameters, it may prevent the system from recognizing or applying the necessary linking parameters. For the linking parameter to remain available and configurable, it must be explicitly included in the service parser definition.
Example (Moazine collection):
Service Parser Parameters:
url=https://dl.moazine.com/lib/main.asp?...26s_t=%26m_id= & libid=$$ACCOUNTID
The segment ' & libid=$$ACCOUNTID' is required. If a local override is in place, this segment must be included; otherwise, the ACCOUNTID linking parameter field will not appear, and the correct institutional value cannot be provided.
If you are activating a collection for Full Text in CDI only and the collection contains portfolios and linking parameters, you must fill in the linking parameters in the Electronic Service Editor to ensure that CDI linking works as expected. For more information about CDI-only activations, see Single Activation with the EasyActive Setting or Single Activation with the Fully Flexible Setting.
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.

-
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.
-
The Linking Parameters at the service or collection levels can also be updated via e-inventory API: https://developers.exlibrisgroup.com/alma/apis/electronic/
Providers Require Customer Parameters: Status and Specific Instructions
This list is dynamic and updated with new Providers
| Provider | Working with Alma/SFX customer parameters? | Parameter | Specific Instructions |
| ProQuest | Supported since March 2025 | CLIENTID | |
| Gale | March 2025 | LOC_ID | |
| Moazine | Will be supported May 2026 | ACCOUNTID | As of 1.5.26, CDI will no longer support Primo linking templates for Mozaine linking. |
| InfoBase | Will be supported June 2026 | ||
| O'reilly | Will be supported June 2026 | ||
| Statista | Will be supported Q3 2026 | ||
| Toyo Keizai | Will be supported Q3 2026 | ||
| Editions ENI | Will be supported Q3 2026 | ||
| Psychotherapy.net | Will be supported Q3 2026 |

