Extending Rosetta

General Purpose

Rosetta integrates with other systems via standard protocols and specifically developed APIs. This page describes the integrations, protocols used, and the guidelines for adding new integrations.


Rosetta can authenticate users locally or externally. Two types of external authentication methods are supported:  

  • SAML: Authenticate users managed by an IdP using the SAML protocol. Supported as of Rosetta version 5.2. See details here.
  • PDS: A “back‐end” web component that facilitates user authentication and login to an Ex Libris application. For the full list of the PDS APIs and Web Services, please refer to the javadoc.

Note: PDS authentication is planned to be deprecated as of Rosetta v.6.0.

The default authentication method and default instituton are defined using the default_authentication_mode and login_default_institution General Parameters, respectively. To override the default settings, users should provide an authentication method and/or institution in the login URL, e.g.:

CMS Synchronization

Content Management Systems (such as Aleph and Voyager) can be integrated with Rosetta in such a way as to support the synchronization of metadata between IEs in Rosetta and matching IEs (or “documents”) in the external systems. In this way, IE(s) in Rosetta can be associated with richer and better maintained descriptive metadata that can be retrieved during delivery and displayed as a whole to the end user. The CMS integration uses the SRU protocol and dedicated APIs that were developed for each integration separately.

To set up ILS integration, refer to the Rosetta-Aleph and Rosetta-Voyager integration guides on the Documentation Center.

Persistent Identifiers

Persistent Identifiers (PIs) are character strings that uniquely identifies an object, such as an electronic document.
Rosetta currently integrates with three different systems (Handle, URN:NBN, and NLB PID) and provides a generic mechanism that allows other types of PIs to be generated and published in Rosetta.
Further information is available in the ‘Digital Object Identifiers’ section in the Rosetta Configuration Guide.