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

    Requests to Remote Storage Facilities

    Translatable
    To configure a remote storage type of integration profile, you must have the following role:
    • General System Administrator
    To associate a remote storage profile with a remote storage facility, or update the locations that use the remote storage facility, you must have the following role:
    • Fulfillment Administrator
    When Alma places a resource request on an item that belongs to a remote storage location, an automatic job exports the requested information to a defined FTP location. The remote storage system then retrieves the file and processes it. To configure remote storage, see Configuring Remote Storage Facilities.
    The files placed at the FTP location adhere to the rules defined in the external_sys_remote_storage_export_requests.xsd file (for details, see https://developers.exlibrisgroup.com/alma/apis/xsd/external_sys_remote_storage_export_requests.xsd).
    To configure the export of requests to a remote storage system, perform the following actions:
    1. Configure an S/FTP connection to be used by Alma and the remote storage system (see Configuring S/FTP Connections).
    2. Configure a remote storage type of integration profile (see below).
    3. Associate the remote storage profile with a remote storage facility (see below).
    4. Update the physical locations that use this remote storage facility (see below).
    • For information on running and monitoring the remote storage export job after you have configured all of the above, see Manually Exporting to Remote Storage.
    • The XML/NCIP ASRS is currently being developed and is not yet fully functional.
    For details on the remote storage integration types supported by Alma, see the following sections:

    Configuring Remote Storage

    To configure a remote storage type of integration profile:
    1. On the Integration Profile List page (Administration > General Configuration > Configuration Menu > Integration Profiles, External Systems), click Add Integration Profile. The first page of the integration profile wizard opens.
    2. Perform the following actions on this page:
      1. Enter a code and name for the profile you are defining.
      2. From the Integration type drop-down list, select Remote storage.
      3. From the S/FTP connection type drop-down list, select the name of the FTP connection that you previously defined.
      4. Optionally, enter a description of the integration you are configuring.
        Remote Storage Integration Profile Definition – Page 1
    3. Click Next. The second page of the wizard opens.
      Remote Storage Integration Profile Definition – Page 2
    4. In the Export Requests section:
      1. Select whether you want the profile to be active. Note that only active profiles can be run.
      2. From the Plugin drop-down list, select the out-of-the-box plug-in to be used.
      3. In the Export file path field, enter a subdirectory of the path specified when creating the S/FTP connection. For example, if you specified Alma in the Sub-directory field during S/FTP connection configuration and you enter remote storage in the Export file path field, the invoices are exported to the Alma/remote storage directory.
      4. Under Request types to export for schedule, select Yes for the request types you want to export with scheduled integration profile export jobs.
        In the Schedule frequency field, select the frequency by which the export job is to run.
      5. Under Request types to export for running job, select Yes for the request types you want to export with manually run integration profile export jobs.
    5. Click Save. The profile you configured appears in the Integration Profile List.

      When the scheduled/manual job runs, one barcode is sent per request, and the following new fields are displayed in the XML:
      • Shipping Address of the target pickup location or requesting partner if the request is a resource sharing request
      • MMS ID
      • Item ID
      • Library Code of the Target Pickup Location
      The item that is automatically selected by the system is marked as Not Available, with Process Type = Requested.
    When configuring a Dematic ASRS remote storage integration profile for a Dematic ASRS system, you must run the Inventory Remote Storage Update job (see https://developers.exlibrisgroup.com/alma/apis/xsd/external_sys_remote_storage_export_requests.xsd).
    To associate a remote storage profile with a remote storage facility:
    To update the physical locations that use the remote storage facility:

    Manually Exporting to Remote Storage

    To manually run and monitor the remote storage export job:
    On the Integration Profile List page (Administration > General Configuration > Configuration Menu > Integration Profiles, External Systems), select Actions > Edit for the remote storage profile you defined, click the Actions tab, ensure that the Active radio button in the Export Requests section is selected, and then click Run.
    Running the Remote Storage Export Job
    The job runs as soon as the system can accommodate it. If email notifications are enabled in Alma, you receive notification via email.
    You can view the status of the job, the number of files processed, and other data by selecting Actions > Job history for the appropriate remote storage profile on the Integration Profile List page. For example, the following figure shows a job that completed successfully, processing one file.
    Export Job History
    The status Completed Successfully does not mean that requests were exported successfully. Rather, it means that the job completed without error.
    You can use the Actions menu to access a more detailed job report, including statistics on the number of request records and request records with exceptions processed (Actions > View), events that occurred during the job processing (Actions > Events), and a report of errors (Actions > Error reporting).