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

    External Systems

    Translatable

    Configuring Integration Profiles

    To configure integration profiles, you must have the following role:
    • General System Administrator
    Alma integrates with external systems such as vendor systems, Enterprise Resource Planning systems, catalog systems, remote storage systems, and so forth) using standard protocols (such as S/FTP). For more information, see Integrations with External Systems.
    Some integration profiles create jobs that can be used to export information to, or import information from, an external system. Other integration profiles provide tokens and codes to use to configure external systems.
    You begin configuring integration profiles on the Integration Profile List page (Administration > General Configuration > Configuration Menu > General > External Systems > Integration Profiles).
    Integration Profile List Page
    The Integration Profile List page includes a list of the integration profiles.
    You can perform the following actions on this page:
    • Add an integration profile (see the linked sections in the table below).
    • Edit an integration profile (Actions > Edit in the row actions list). When editing a profile, you cannot change the profile type. In addition, you can add contact information relevant to the profile n the Contact Information tab. For more information about the fields on this tab, see Configuring Institution/Library Contact Information.
    • Delete an integration profile (Actions > Delete in the row actions list).
    • View job history (Actions > Job History in the row actions list; see Viewing Completed Jobs.)
    For information on adding/editing an integration profile, see the following sections:
    Links to Information about Integration Profiles
    Profile Type Description More Information

    Aleph Bridge Integration

    Integrate a non-Alma member's inventory from a central system into a bridge institution that is managed by the Alma Network Zone.

    This feature is under construction.

    Authority Record Contribution   For future use
    Bursar Export fines and fees to the institution’s bursar system. Exporting Fines and Fees to a Bursar Systems
    CAS Exchange authentication and authorization information for single sign-on with an external system. CAS-Based Single Sign-On/Sign-Off

    Central Catalog Integration

    Integrate an external Central Catalog with Alma.

    Cloud IdP   For future use
    Course Loader Import course from a course management system. Configuring Course Loading
    Digital Content Store Integrate with the UK CLA's Digital Content Store. Integrating with the UK's Digital Content Store (DCS)
    Discovery Interface Configure the location map link in the Get It tab. Configuring the Delivery Tabs
    Finance Import and export orders and invoices by vendors from and to an institution’s financial system. Financial Systems
    LDAP Import information from an Lightweight Directory Access Protocol (LDAP) system. Supporting LDAP
    LTI Tool Authentication between Leganto and your course management system. Configuring Learning Tools Interoperability (LTI)
    Link Resolver Plugin Performs external checks using an API that determines the most accurate available URL for the full text. Configuring the Link Resolver Plugin for Checking EBSCOhost Full-Text URLs
    Link Resolver Statistics Integrates the connection between Alma and bX for sharing Alma link resolver data statistics. Sharing Alma Link Resolver Data Statistics with bX
    Linked Data Publish structured linked data. Linked Data
    Mail Handling Outgoing email handling Configuring Outgoing Email
    New Order API Synchronize records from a vendor’s database to a purchasing or licensing library’s offerings. Real-Time Ordering
    OAI Repository Definition Publish records as OAI types. Setting Up OAI Integration
    OCLC Connexion Import records from OCLC Connexion. Importing Records from OCLC Connexion
    Online Payment Send payment receipt emails to the user using he WPM Education E-Payment System. Configuring the WPM Education E-Payment System
    Online User Update   For future use
    RFID Using an RFID reader, communicate with RFID tags on items. RFID Support
    Remote Storage Request a resource from a remote storage location or Automated Storage and Retrieval System. Requests to Remote Storage Facilities or Configuring the Dematic ASRS
    Resolver Augmentation Configure OpenURL enrichment. Alma Resolver Augmentation
    Resolver Proxy Configure a resolver proxy definition Resolver Proxies or OpenAthens LA Proxy Support
    Resource Sharing Integration Import borrowing requests from an external system. Importing Resource Sharing Borrowing Requests From an External System
    SAML Exchange authentication and authorization information for single sign-on with an external system. SAML-Based Single Sign-On/Sign-Off
    SMS Communication Configure SMS communication with patrons. SMS Communications
    SRU Server Activate SRU/SRW searching capability. SRU/SRW Search
    SWORD Server Submit content to Alma to be added to the repository. Configuring the SWORD Server Integration Profile
    Self Check Configure communication between Alma and a self-check machine. Self-Check Machines
    Social Login Configure connection with social networks for user login. Social Login
    Upload Electronic Holdings Upload and update Elsevier electronic holdings.
    Upload and update Ovid electronic holdings.
    Upload Electronic Holdings from Elsevier
    Users Export/import users to/from a Student Information System. Student Information Systems
    Webhooks Trigger a HTTP request to a configured URI when a job ends. Webhooks
    Z39.50 Server Activate Z39.50 searching capability. Z39.50 Search

    Configuring S/FTP Connections

    To configure S/FTP connections, you must have the following role:
    • General System Administrator
    Many connections to external systems require an S/FTP connection, which is used by Alma and the external system to transfer files. Once this connection is defined, it can be assigned to applicable integration profiles (see Configuring Integration Profiles).
    You configure S/FTP connections (for institutions only) from the List of S/FTP Connections page (Administration > General Configuration > Configuration Menu > General > External Systems > S/FTP Definitions).
    List of S/FTP Connections Page
    Alma supports the following key exchange algorithms, using JSch version 0.1.53 (see http://www.jcraft.com/jsch/):
    • diffie-hellman-group-exchange-sha1
    • diffie-hellman-group1-sha1
    • diffie-hellman-group14-sha1
    • diffie-hellman-group-exchange-sha256
    • ecdh-sha2-nistp256
    • ecdh-sha2-nistp384
    • ecdh-sha2-nistp521
    Ex Libris supports deprecated versions for backward compatibility with various sites, but recommends the stronger algorithms above.
    You can perform the following actions on this page:
    • Add an S/FTP connection (see Adding S/FTP Connections)
    • View an S/FTP connection (Actions > View in the row actions list).
    • Edit an S/FTP connection (Actions > Edit in the row actions list)
    • Duplicate an S/FTP connection (Actions > Duplicate in the row actions list)
    • Delete an S/FTP connection (Actions > Delete in the row actions list)

    Adding S/FTP Connections

    You can define a new S/FTP connections for use by your integration profiles.
    To add a new S/FTP connection:
    1. On the List of S/FTP Connections page (Administration > General Configuration > Configuration Menu > General > External Systems > S/FTP Definitions), click Add S/FTP Connection. The Update S/FTP Connection page appears.
      Update S/FTP Connection Page
    2. Enter a name (mandatory) and a description (optional) for the new S/FTP connection.
    3. Enter information in the remaining fields, as described in the following table.
      S/FTP Connection Fields
      Field Description
      Server (mandatory) The IP address of the server sending or receiving the files. Cannot begin with a dot, and cannot begin or end with a quotation mark.
      Port (mandatory) The server port.
      Sub-directory The subdirectory in which the files are saved. The directory must be a relative path (not start with a /).
      If you also specify a sub-directory in the integration profile, this directory is concatenated onto that one. For example, if you define the system1 S/FTP connection as: Sub-directory – ftp
      And you define an Export Bibliographic Records profile with:
      • FTP configuration – system1
      • FTP sub-directory – alma
      Then files transferred by this integration profile are saved in the external system’s ftp/alma directory.
      This field cannot remain empty if you select MVS as the FTP server type. (An error message will be displayed.)
      Max. number of files Not in use. Accept the default value.
      Min. number of files Not in use. Accept the default value.
      Max. file size Not in use. Accept the default value.
      Size type The units used for the files sizes. Valid values are: GB, MB, and TB. The default value is GB.
      Allow navigation True if you want to enable access to other areas of the FTP site, or False if you do not. The default is to allow navigation (True).
      FTP server type Default or MVS. Select MVS to work with IBM’s Multiple Virtual Storage operating system.
      FTP passive mode Whether the client IP works in passive mode.
      The OCLC publishing integration profile requires passive mode.
      FTP server secured Select if the FTP server is secured. The Authentication Method option appears when this option is selected.
      If you select MVS as the FTP server type, do not select this. Secure MVS servers are not supported.
      Authentication method
      Appears if FTP Server Secured is enabled. Select one of:
      • Username/password authentication - Use a user name and password.
      • Key authentication (public key encryption) - When you select this, a public key appears. The public key is used to authenticate files received from Alma. When this option is selected, the password field is removed.
      User name (mandatory) The S/FTP user name. This field appears and is required regardless of whether or not you are using secured FTP.
      Password (mandatory, except when Key authentication is selected) The S/FTP password. Required unless you are using key authentication.
      Alma does not support passwords that include special characters.
      Public key
      The public key appears on the page if Key Authentication is selected for Authentication method.
      Alma's public key. You must add this key to the .ssh/authorized_keys file on your FTP server.
      Every Alma institution has its own public key. When implementing a Network Zone, customers must add the public key of each institution into their authorized_keys file.
    4. Click Test FTP (recommended) to test the S/FTP connection. You should receive messages indicating that the following FTP command actions were successful:
      • List and check files in the specified directory using ls, pwd, and cd commands
      • Upload and download files using the put and get commands
      • Delete using the delete command
      If you do not receive success messages for these actions, resolve your S/FTP connection issues before continuing.
    5. Click Save when you are done.

    Configuring Allowed Emails

    To configure allowed emails, you must have the following role:
    • General System Administrator
    This feature is only available in a) a sandbox environment or b) on the Alma production environment for customers who are still in the implementation/testing phase and are not yet configuration certified.
    You can define specific email addresses/domains to use for your institution's communication during testing. This avoids any stray communications: Alma does not send emails to any other email addresses.
    Email communication is restricted to the email addresses in this table only if at least one email address is defined in the table. Do not fully delete all of the entries in this table. If this table is empty, unrestricted email communication is enabled for any email address entered anywhere in Alma.
    You configure emails or domains on the Email Include List mapping table (Administration > General Configuration > Configuration Menu > General > External Systems > Allowed Emails). For more information about mapping tables, see Mapping TablesMapping Tables.
    Email Include List Mapping Table
    You can add, delete, or enable/disable domains and addresses. Alma only sends emails to the active addresses and/or domains.
    Domains only work in an implementation production environment, and not in sandbox environments.

    Configuring Allowed S/FTP Connections During Testing

    To configure allowed S/FTP connections, you must have the following role:
    • General System Administrator
    This feature is only available in a) a sandbox environment or b) on the Alma production environment for customers who are still in the implementation/testing phase and are not yet configuration certified.
    Alma enables you to define allowed S/FTP connections to be used for your institution's communication during testing. This avoids any stray file transfers: Alma does not try to use any other S/FTP connections.
    S/FTP is restricted to the addresses in this table only if at least one address is defined in the table. Do not fully delete all of the entries in this table. If this table is empty, unrestricted S/FTP communication is enabled for any address entered anywhere in Alma.
    You configure test S/FTP connections on the FTP Include List mapping table (Administration > General Configuration > Configuration Menu > General > External Systems > Allowed S/FTP Connections). For more information about mapping tables, see Mapping TablesMapping Tables.
    FTP Include List Mapping Table
    You can add, delete, or enable/disable addresses.