Skip to main content
ExLibris
  • Subscribe by RSS
  • ExLibris Dev

    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). 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 for configuration in external systems. Also see Integrations with External Systems.
    You configure integration profiles on the Integration Profile List page (Administration > General Configuration > Configuration Menu > External Systems > Integration Profiles).
    Integration Profile List Page
    The Integration Profile List page includes a list of the integration profiles.
    Integration Profile List Page
    You can perform the following actions on this page:
    • Add an integration profile (see the linked sections in the table below for instructions on each type of integration profile).
    • Edit an integration profile (Editing an Integration Profile)
    • Delete an integration profile (Actions > Delete)
    • View job history (see the relevant sections in Configuring Integration Profiles.)
    For information on adding an integration profile, see the following sections:
    Links to Information about Integration Profiles
    Profile Type Description More Information
    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 Integrating an Aleph Central Catalog
    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 Import and continuously update Elsevier electronic holdings.
    Upload and update Ovid electronic holdings.
    Importing Elsevier Holdings
    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

    Editing an Integration Profile

    To maintain your integration profiles, use the editing capability provided as one of the actions.
    To edit an integration profile:
    1. On the Integration Profile List page (Administration > General Configuration > Configuration Menu > External Systems > Integration Profiles), select the integration profile using one of the following methods:
      • Click the code number of the profile.
      • Scroll to the profile and click Actions > Edit.
      The parameters for the General Information tab appear.
      External System Page – General Information Tab
    2. Modify the information on each tab, as required. For details on the Actions tab fields, see Links to Information about Integration Profiles.
    3. Click Save. The changes are saved on the Integration Profile List page.

    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 between systems. Once this connection is defined, it can be assigned to the 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 > 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 the 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 a defined S/FTP connection (Actions > View)
    • Edit a defined S/FTP connection (Actions > Edit)
    • Duplicate a defined S/FTP connection (Actions > Duplicate)
    • Delete a defined S/FTP connection (Actions > Delete)

    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 > External Systems > S/FTP Definitions), click Add. The Update S/FTP Connection page appears.
      Update S/FTP Connection Page
    2. Enter a name (required) 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 (required) 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 (required) 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 (required) The S/FTP user name. This field appears and is required regardless of whether or not you are using secured FTP.
      Password (required, 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 FTP upload, download, and delete were successful. If you do not receive these messages, resolve your S/FTP connection issues before continuing.

    Configuring Allowed Emails

    To configure allowed emails, you must have the following role:
    • General System Administrator
    Allowed emails is not available in a regular production environment. The configuration is available and active in the sandbox environment and 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.
    When the table is accessible during testing, do not fully delete the entries in it, since emptying the table allows unrestricted S/FTP communication with any defined S/FTP in the system. Once emails/domains are defined, only the defined emails/domains are allowed.
    You configure emails or domains from the Email Include List Mapping Table page (Administration > General Configuration > Configuration Menu > External Systems > Allowed Emails). For more information about mapping tables, see Mapping Tables.
    EmailIncludeList Mapping Table Page
    Use the Quick Add area to add a new email/domain. You can enable/disable an email/domain or click Delete to delete the email/domain.
    An email domain works only 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
    Allowed S/FTP Connections are not available in a regular production environment. The configuration is available and active in the sandbox environment and 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.
    When the table is accessible during testing, do not fully delete the entries in it, since emptying the table allows unrestricted S/FTP communication with any defined S/FTP in the system.
    You configure test S/FTP connections from the FTP Include List Mapping Table page (Administration > General Configuration > Configuration Menu > External Systems > Allowed S/FTP Connections). For more information about mapping tables, see Mapping Tables.
    FTP Include List Mapping Table Page
    Use the Quick Add area to add a new connection. You can enable/disable a connection or click Delete to delete the connection.
    • Was this article helpful?
    --> //doorbell.io feedback widged