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

    Resource Sharing Partners

    Translatable
    To configure the communication between Alma and resource sharing systems, you must have the following role:
    • Resource Sharing Partners Manager
    Resource sharing partners can be created to define the types of request/receive communication that can take place between Alma and a resource sharing system:
    • NCIP – Communication between Alma and resource sharing systems, such as OCLC Navigator, OCLC iLLiad, VDX, and Relais D2D, via NCIP 2.0 messages. Note that Alma supports the OCLC CIRC ILL and Relais application profiles for both borrowing and lending, as well as the responder role for the following NCIP messages: RequestItem, CheckOutItem, CheckInItem, AcceptItem, LookupUser.
      • Alma notifies the partner when an item renewal is requested by sending a RenewItem message to the partner with item information and a desired due date. The partner responds with a pending status and possibly a DateOfExpectedReply. The partner system may also notify Alma about the status of the renew request. Alma receives an NCIP CirculationStatusUpdated message with a circulation status of
        • Renew Still Pending - Marks the request as Renew Requested.
        • Item Not Renewed - Manages the request as it does when a renew request is rejected.
      • Checking in a single request with multiple items will create a CheckInItem request for each of the items.
    • ARTEmail – Communication between Alma and the British Library resource sharing system.
    • ISO – Communication between Alma and another resource sharing (Alma or non-Alma) system.
    • Email – The sending of borrowing requests by the Alma borrowing partner via email.
      Email requests are sent in XSL format. The XSL used for formatting the email is FulOutGoingEmailLetter.xsl and is configurable on the Configuration Files page (see Customizing Letter XSL Style Sheets).
    • SLNP – Communication between Alma and the ZFL server for the resource sharing workflow in Germany.
      Full integration details with this partner are available in the Alma Developer Network at https://developers.exlibrisgroup.com/alma/integrations/resource_sharing/broker/SLNP.
    • BLDSS – Communication between Alma and the British Library resource sharing system. For more information, see British Library Document Supply Service.
      • The Service/Speed element of the CreateOrder message is mapped to the levels of service table. The BLDSS mapping levels are:
        • EXPRESS_LOCAL - Immediate Download
        • RUSH_LOCAL - 2 Hours
        • PRIORITY_LOCAL - 24 hours
        • NORMAL_LOCAL - Within 4 days
        The BLDSS levels of service map to Alma's levels of service as follows:
        BLDSS Message Mapping
        BLDSS Message Alma Message(s)
        Immediate Download Express (Local)
        2 Hours Rush (Local)
        Rush (Extended)
        24 Hours Priority (Local)
        Priority (Extended)
        Within 4 days Normal (Full)
        Normal (Local)
        When Convenient
      For more information on levels of service, see Configuring Levels of Service
    • External Systems - Used to receive a resource through the CCC GetItNow service.
    • Fulfillment Network - For institutions configured as a fulfillment network, a partner record is entered in order to use the resource sharing framework for the fulfillment network request. For more information, see Fulfillment Network Requests.
    For detailed information on broker-based resource sharing between Alma and various systems, see https://developers.exlibrisgroup.com/alma/integrations/resource_sharing/broker.
    In order to create a partner that works with SBN ILL, an ISO partner must be created in Alma.
    To configure a resource sharing partner:
    1. On the Resource Sharing Partner List page (Fulfillment > Resource Sharing > Partners), click Add Partner. The Resource Sharing Partner page opens to the General Information tab.
      Resource Sharing Partner General Information NZ.png
      Resource Sharing Partner Page – General Information
    2. Enter a code and name for the resource sharing partner. Note that the code can contain only alphanumeric characters.
    3. In the Profile type field, select the type of protocol — NCIP, ISO, Email, or ARTEmail, NCIP-P2P, SLNP, External System — you want to create.
      To learn more about the NCIP-P2P protocol, please refer to the Developer Network.
    4. Optionally, select Inactive from the Status drop-down list if you do not want the partner to be active.
    5. Select the resource sharing system with which you are integrating from the System type drop-down list (for Ex Libris’ informational purposes). Note that this is mandatory.
      For a profile with an External System profile type, select CCC GetItNow as the System Type (this is the default).
      When an NCIP profile is configured, the indicated broker types must be configured with the following parameters:
      • Relais:
        • Request pushing method = OpenURL
          The URL is defined as follows, where the XXX and YYY values are provided to each institution by Relais:
          https://h7.relais-host.com/<XXX>/loginRFT.jsp?LS=<YYY>
        • Add User to Login = Yes
        • Enable Service for Guest User = No
        • Loan Period = <Free text, which is displayed in the Get It tab>
      • OCLC Navigator:
        • Request pushing method = Link
          The Navigator system cannot receive an OpenURL as input; the configurable link can only be a static link. To configure a dynamic link to the Navigator system, use General Electronic Services (see Adding a General Electronic Service).
        • Enable Service to Guest User = Yes
          Navigator requires a new login when being accessed.
        • Loan Period = <Free text, which is displayed in the Get It tab>
      • INN Reach:
        • Request pushing method = Link
          A link is created by a General Electronic Service with an OpenURL template, as described in Adding a General Electronic Service.
        • Enable Service for Guest User = No
          INN Reach does not trigger an authentication process, as authentication is expected to have taken place before accessing the INN Reach request form.
        • Loan Period = <Free text, which is displayed in the Get It tab>
      • ILLiad:
        • Request pushing method = Link
          A link is created by a General Electronic Service with an OpenURL template, as described in Adding a General Electronic Service.
        • Add user login to URL = No
          ILLiad requires logging in again
        • Enable service for guest user = Yes
        • Loan Period = <Free text, which is displayed in the Get It tab>
          The configured brokers display as links on the Primo Get It tab. For more information about brokers in the Get It tab, see More Information About Resource Sharing Broker in Get It.
      You can also configure the following:
      • General Electronic Services – Displays a Primo link to an external service (such as Amazon), as an additional way to retrieve resources. You can also create rules to assign different links to be used for different resources (such as for a book or DOI). For details, see Adding a General Electronic Service.
      • Display Logic Rules – Indicates when a certain broker link will display or be hidden in Primo (see Configuring Display Logic Rules).
    6. Enter values in the Average supply time, Delivery delay, and Currency fields, and select the Supports borrowing and/or Supports lending check boxes.
      If you select Supports borrowing and/or Supports lending, choose one of the workflows from the drop-down list options predefined by an administrator (in Fulfillment > Fulfillment Configuration > Configuration Menu > Workflow Profiles). For details on configuring workflow profiles, see Configuring Workflow Profiles.
      The workflows selected here control the actions that can be performed on the borrowing and lending request task lists for the defined partner.
    7. In the Delivery delay field, enter the number of days needed for delivery of the item. The due date calculated when the received item is loaned to the requesting patron is automatically advanced by the number of days indicated in this field.
      For example, if the due date when receiving the item is June 5, 2013 and Delivery Delay = 4, the Due Date value displays on the Patron Services page as June 1, 2013, to allow 4 days for item delivery and ensure that the item arrives by its 'actual' due date of June 5.
      For more information about managing the due date for an interlibrary loan, see the Interlibrary Loan With Due Date video (7:01 mins).
    8. The Local Status field appears for institutions that centrally manage their partner records in the Network Zone. It allows an individual institution to locally deactivate a partner record even though the partner is active for the collaborative network.
    9. In the Locate profile field, select a locate profile to determine how the partner’s catalog is to be searched. The Holding code field appears.
      Resource Sharing Partner Page - Holding Code Field
      For details on locate profiles, see Configuring Locate Profiles.
    10. In the Holding code field, enter a library or campus code. The locate process for the partner searches the library/campus indicated by the value in this field.
      Specifying a holdings code enables you to do the following:
      • Determine whether a requested resource is available at a specific campus of a potential supplier.
      • Request the resource from that lender only if the resource is owned at the requested campus.
    11. In the Contact Information tab, add address, phone number, and email information for the resource sharing partner (for informational purposes only; information for sending the resource sharing request is entered in the Parameters tab – see the following step). For instructions, see Adding User Contact Information.
    12. In the Parameters tab, configure the resource sharing parameters. For more information, see Partner Parameters below.
      Resource Sharing Partner Page – Parameters Tab
    13. Click Save. The resource sharing partner is created and appears on the Resource Sharing Partner List page.
      The partner can then be selected from the Partner drop-down list (accessible when clicking the Edit, Duplicate, or Send options on the Resource Sharing Borrowing Requests page) or Supplied to drop-down list (accessible when clicking the Edit or Duplicate options on the Resource Sharing Lending Requests Task List page).
      A Notes tab is available when editing the resource sharing partner (Actions > Edit).

    Partner Parameters

    ARTEmail Parameters

    Enter the ARTEmail email address. In addition, for each customer ID you add, you must enter a code and password. Optionally, if you want to enable the ability to send requests to an alternate physical location or email address (which you can select to do in the Request Attribute section of the Creating a Borrowing Request page), you may select the Supports ADD request check box. You may also select keyword codes—that is, request values—to include. (Refer to the British Library’s Guide to ARTEmail for an explanation of these values.) These define the communication that is possible vis-a-vis the resource sharing partner

    NCIP Parameters

    Configure parameters as described in the following table:
    NCIP Parameters
    Section Field Description
    General Information User identifier type (Required) The identification type that will be used to match users when a message contains a user ID. Select one of the options predefined by an administrator. See Viewing User Identifiers.
    Request pushing method (Required) Select the type of link — OpenURL or Link—that will be used to push the request into the resource sharing system. If you select OpenURL, the Add user auto login field appears.
    URL template The URL that is used to send patrons from Primo to the resource sharing library’s Web site.
    Broker System NCIP URL The URL to communicate with the NCIP broker.
    Add user auto login to URL Select Yes to add a user’s login credentials to the URL, thereby logging the user in automatically upon accessing the URL. This field displays only when Request pushing method = OpenURL.
    Select Yes when configuring integration with a Relais system (see Configuring Alma/Broker Integration).
    Enable service for guest user Indicates whether the link to the partner displays in Primo when the patron is not logged in.
    Disable service when Select the parameters upon which the service is to be disabled. Possible values are:
    • Never – The service is never disabled.
    • When resource is owned by the campus – The service is disabled when physical items for the resource are owned by the campus.
    • When resource is self-owned by campus and available – The service is disabled when physical items for the resource are owned by the campus and are available (that is, they are not involved in a process).
    • When resource is owned by the library – The service is disabled when there are physical items for the resource that are owned by the library.
    • When resource is owned by the library and available – The service is disabled when there are physical items for the resource that are owned by the library, are in place, and are in an open location.
    When a guest user or a user without a configured campus performs any of the campus-level disabling activities, Alma disables/hides the service based on a self-ownership check done on the institution level.
    Loan period The amount of time the user has before having to return the item to the resource sharing library. (This may be seen by patrons in Primo.)
    Default library owner The resource sharing library which manages the borrowing request created by this profile.
    Download Certificate Button
    This button is used to authenticate the TCP communication for encrypted messages sent to Alma using the SLNP protocol.
    The button appears for NCIP partners after the partner has been saved the first time.
    For more information on the certificate, see the Developer Network.
    Request Item
    An NCIP message is sent when a lending request is registered on the borrowing side.
    Resource sharing library The single resource sharing library that is supported for all actions. Select from a list predefined by an administrator.
    Bibliographic record ID type Select a parameter by which resource sharing requests are to be searched. Possible values are:
    • OCLC Control Number
    • MMS ID
    • LCCN
    • ISBN_ISSN
    • Taken from message – Indicates that the bibliographic record ID type is to be taken from the NCIP message sent by the partner. The relevant value is one of the other values available in this field, and is taken from the BibliographicRecordIdentifierCode tag in the message.
    Check Out Item
    An NCIP message is sent when an item is shipped from the lending side to the borrowing side.
    Default library (Required) The resource sharing library to be used as the default, if there are multiple resource sharing libraries.
    Default location
    (Required)
    The temporary location at the resource sharing library that will be assigned to an item that is shipped to a resource sharing borrower. Select from a list predefined by an administrator.
    Default item policy
    (Required)
    The policy that will be attached to an item that is shipped to a resource sharing borrower. Select from a list predefined by an administrator.
    Accept Item
    An NCIP message is sent when the arrival of an item is registered on the borrowing side.
    Default location (Required) The temporary location at the receiving library. Select from a list predefined by an administrator.
    This location is assigned to an item that is shipped to a resource sharing borrower, unless a different location has been assigned by a Temporary Item Creation Rule.
    Resource sharing library The resource sharing library, if there are multiple resource sharing libraries.
    Default pickup library The default pickup location to which temporary items are transferred when an item arrives for a borrowing request. Select from a list of libraries predefined by an administrator.
    Automatic receive
    Select to enable receiving resource sharing items automatically. Automatic receiving enables staff to register a Receive action in the broker system, without having to repeat the Receive action in Alma.
    Enabling this option allows multiple AcceptItem requests to be processed for a single multi-item borrowing request. This is applicable if the requests contain the same request ID but different barcodes and the request ID is active. If the option is not enabled, multiple requests will be created with the same request ID.
    Receive desk Select a desk at which the item is to be received. The available options are the desks of the library that is specified in the Default library owner field. The value you select indicates the location where the item arrives when the AcceptItem message is received.
    This field displays only when Automatic receive is selected.
    Look Up User
    An NCIP message is sent when a patron attempts to create a request at the resource sharing system.
    Require authentication Select whether authentication should or should not be required for the resource sharing library’s Web site. When working with a Relais broker, select No.
    You must also configure the following parameters on the NCIP partner:
    • The NCIP URL, in the following format: https://<Alma domain>/view/NCIPServlet
    • The AgencyID, which is your Alma institution code
    • The ApplicationProfileType, which is the code defined on the Resource Sharing Partner page (see step 2 above)

    NCIP Peer-to-Peer Parameters

    • Supports ADD request – Select this box if you want to enable the ability to send requests to an alternate physical location or email address (which you can select to do in the Request Attribute section of the Creating a Borrowing Request page).
    • User identifier type – The identification type that will be used to match users when a message contains a user ID. Select one of the options predefined by an administrator. See Configuring User Identifiers.
    • Server – Enter the partner’s server name (or IP address).
    • Institution code – Enter the partner's Alma institution code.
    • Partner symbol – The symbol by which the ILL partner is referred.
    • Request Expiry – Configure when the partner’s lending settings expire. Choose from the following:
      • No expiry: The request does not expire
      • Expire by interest date: The request expires on the date specified in the Needed by field on the Resource Sharing Borrowing Request page (displayed when creating a borrowing request).
      • Expiry time: The Expiry time field appears, where you enter a number. This value indicates the number of days after the request has been sent to the lender that the request expires.
    • Send requester information – Select for resource sharing requests sent via the specified partner to contain the requester’s information.
    • Shared barcodes – Select to enable sharing item barcodes between lending and borrowing institutions.
      An additional option available for NCIP peer-to-peer configuration is the Lookup Agency button. Clicking this button contacts the partner and returns their supported protocol or other information the partner wishes to transmit to assist in the partner configuration process. You may also set your institution's information that will be transmitted to other partners by customizing the resource_sharing_protocol parameter of the Fulfillment mapping table. For information on modifying this value, see Configuring Other Settings

    ISO Parameters

    Alma supports the following ISO Resource Sharing messages: ILL Request, Shipped, Received, Returned, Checked-In, Answer – Unfilled, Cancel/Cancel Reply, and General Messages.
    • Supports ADD Address – Select to include the requester’s email in the ILL request, enabling the lending partner to send the shipped resource directly to the requester.
    • Server – the partner’s server or IP address. If the partner also uses Alma, use the Alma domain (see Logging Into and Out of the User Interface) as the server.
    • Port – the partner’s ILL port number. If the partner also uses Alma, this is port 9001.
    • ISO symbol – the symbol by which the ILL partner is referred
    • Request Expiry – configure when the partner’s lending settings expire. Choose from the following:
      • No expiry: The request does not expire
      • Expire by interest date: The request expires on the date specified in the Needed by field on the Resource Sharing Borrowing Request page (displayed when creating a borrowing request).
      • Expiry time: The Expiry time field appears, where you enter a number. This value indicates the number of days after the request has been sent to the lender that the request expires.
    • Send requester information – Select for resource sharing requests sent via the specified partner to contain the requester’s information
    • Shared barcodes – Select to enable sharing item barcodes between lending and borrowing institutions. If both the lending and borrowing partners have this option selected, the lending library sends a barcode with the Shipped message, and the borrowing library uses the Shipped message to determine the lender item's barcode. The barcode displays as the Temporary Barcode value on the Receiving Items page (displayed when clicking Receive for a borrowing request), and can be used for identifying the received item when accessing the Received Items page (see Receiving Items).
    • Ignore Lender Shipping Cost - Select this check box to use the borrower's set cost. When the check box is not selected, the lender-side costs override the borrower's cost. Note that when the check box is not selected, the borrowing institution's cost is overridden even if the lender has not communicated a cost value, i.e. it will be considered as if a value of 0 is communicated to the borrower.
    • Resending Overdue Days Interval – A whole number that indicates the number of days for recurring overdue notifications.

    Email Parameters

    • Email address - The email address to which resource sharing borrowing requests are to be sent. Note that if you are working in a sandbox environment or in a pre-”Go Live” production environment, the entered address must be added to the Email Include List Mapping Table in General Configuration > Configuration menu > External Systems > Allowed Emails. For details, see Configuring Allowed Emails).
    • Resending Overdue Days Interval – A whole number that indicates the number of days for recurring overdue notifications.

    ILLiad Parameters

    ILLiad may be set up in Alma in a peer-to-peer rota as a supplier of last resort (see Peer-to-Peer Resource Sharing in the Resource Sharing Guide), To do so, find the section, Export to Third Party, at the bottom of the parameters tab.
    Click Yes on the Export to Third Party radio button and enter the email address for ILLiad request notifications. Note that ILLiad must be configured to upload emails sent to the configured address and use them to create an internal borrowing request.
    The Close Request when Exported defines whether the borrowing request will be closed after export to ILLiad or will be managed under the same borrowing request. If ILLiad NCIP integration has been configured, setting this parameter to false will enable to continue receiving updates about the request from ILLiad via NCIP throughout its ILLiad lifecycle.

    SLNP Parameters

    • Supports ADD Address – Select to include the requester’s email in the ILL request, enabling the lending partner to send the shipped resource directly to the requester.
    • Server – The partner’s server name (or IP address)
    • Port – The partner’s ILL port number
    • Partner symbol – represents the library Sigel
    • Request Expiry – configure when the partner’s lending settings expire. Choose from the following:
      • No expiry: The request does not expire
      • Expire by interest date: The request expires on the date specified in the Needed by field on the Resource Sharing Borrowing Request page (displayed when creating a borrowing request).
      • Expiry time: The Expiry time field appears, where you enter a number. This value indicates the number of days after the request has been sent to the lender that the request expires.
    • Send requester information – Select for resource sharing requests sent via the specified partner to contain the requester’s information
    • Shared barcodes – Select to enable sharing item barcodes between lending and borrowing institutions. If both the lending and borrowing partners have this option selected, the lending library sends a barcode with the Shipped message, and the borrowing library uses the Shipped message to determine the lender item's barcode. The barcode displays as the Temporary Barcode value on the Receiving Items page (displayed when clicking Receive for a borrowing request), and can be used for identifying the received item when accessing the Received Items page (see Receiving Items).
    • Email Address – The email address for sending overdue notifications
    • Resending Overdue Days Interval – A whole number that indicates the number of days for recurring overdue notifications.

    Fulfillment Network Parameters

    • Customer Code - The Alma customer code of the fulfillment network partner.
    • URL - The Alma URL of the fulfillment network partner.
    • Request Expiry - configure when the partner’s lending settings expire. Choose from the following:
      • No expiry: The request does not expire
      • Expire by interest date: The request expires on the date specified in the Needed by field on the Resource Sharing Borrowing Request page (displayed when creating a borrowing request).
      • Expiry time: The Expiry time field appears, where you enter a number. This value indicates the number of days after the request has been sent to the lender that the request expires.