Skip to main content
ExLibris
  • Subscribe by RSS
  • Ex Libris Knowledge Center

    Using Aleph for User Authentication

    This information is not applicable to Primo VE environments. For more details on Primo VE configuration, see Primo VE.
    When using Aleph to perform user authentication, user information is also requested from Aleph.
    The following steps describe the interaction between the user, Primo, and Aleph to provide authentication and authorization:
    1. The user invokes the sign-in option in Primo.
    2. If the institution has more than one active profile, Primo displays the Primo parallel login page.
    3. After the user selects the Aleph profile, the Authentication manager redirects the sign-in request to Aleph using the host X-Server defined in the configuration.
    4. The user enters his or her credentials.
    5. If the response is positive, the response will also include user information. If the response is negative, an error message will display on the Primo login page.
    6. If the user has been authenticated, Primo will log the user in and redisplay the page from which the login was invoked.
    To configure Primo to use Aleph authentication:
    1. Open the User Authentication Wizard page (Primo Home > Ongoing Configuration Wizards > User Authentication Wizard).
    2. Select your institution from the Owner drop-down list.

      The source of your Primo institution must be Aleph in order use Aleph user authentication.

    3. Create a new login profile. The Login Profile page opens. For more information on creating login profiles, see The Primo Authentication Manager.
    4. Select ALEPH from the Select Authentication Method drop-down list.
      The ALEPH authentication parameters appear on the page.
      AlephLoginProfile.png
      Aleph Login Profile Page
    5. Use the following table to configure the Aleph authentication parameters:
      Aleph Authentication Parameters
      Parameter Description
      ALEPH_HOST
      Enter the base URL for the Aleph server. For example: https://myServer.com
      ALEPH_PORT
      Enter the port for the Aleph server.
      ADM_LIBRARY
      Enter the active Aleph ADM library.
      X_SERVER_USERNAME
      Enter a valid staff user name that is authorized to use the X-server.
      X_SERVER_PASSWORD
      Enter the staff user's password for the specified staff user.
      EMAIL_OVERRIDE
      The valid values are True and False (default).
      If set to True, the email returned with the user information will always override the email stored in the user’s profile in Primo.
    6. Use the following table to configure the Aleph user information fields:
      Aleph User Information Fields
      Parameter Description
      Select User Information Method
      For Aleph authentication, ALEPH is automatically populated for you.
      ALEPH_HOST_I
      Enter the base URL for the Aleph server. For example: https://myServer.com
      ALEPH_PORT_I
      Enter the port for the Aleph server.
      ADM_LIBRARY_I
      Enter the active Aleph ADM library.
      X_SERVER_USERNAME_I
      Enter a valid staff user name that is authorized to use the X-server.
      X_SERVER_PASSWORD_I
      Enter the staff user's password for the specified staff user.
    7. Select Save to save your Aleph profile and to return to the Login Profiles page.
    8. Edit your new Aleph profile. The Login Profile page will now include the Attributes Mapping button.

      The Attributes Mapping button displays only when the user information method has been selected and saved.

    9. Select Attributes Mapping to map the user attributes that are associated with the selected type of user authentication. For more information, see Attribute Mapping.
    10. Select Save to save your profile and to return to the list of profiles on the Login Profiles page.
    • Was this article helpful?