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

    SFX to Alma AutoExtract Migration

    The objectives of the SFX to Alma migration process are to migrate SFX data to the Alma environment quickly and efficiently, eliminate any coordination and scheduling issues with Ex Libris, and enable the independent extraction of data.
    The functioning of SFX is not affected by this process running in the background, and your normal work in SFX can proceed in parallel while it is running. However, we recommend running it during non-peak hours for best performance.
    This document explains how to download and install the SFX to Alma Migration Package, perform the extraction SFX data, and transfer it securely to Ex Libris’ FTP server.
    If you have any questions, contact Ex Libris.


    • Standard migration requirements documented in Getting Ready for Alma and Discovery Implementation.
    • SFX needs to be on v4.12 or above to migrate to Alma.
    • Open an access in your firewall to the Ex Libris SFTP server in order to transfer the extracted data:
      • APAC customers:
      • EU customers:
      • NA customers:
      • CANADA customers:
      • CHINA customers:
    Verify that you have at least 2 GB of free disk space.

    Overview of the AutoExtract Process

    The following steps describe the SFX AutoExtract process:
    1. An email with the following information is sent to you by Ex Libris:
      • A link to the AutoExtract package path on FTP server
      • Credentials for FTP download
    2. Download the AutoExtract package from the FTP server.
    3. Install the AutoExtract package on your SFX server.
    4. Run the extraction of your SFX data using the AutoExtract package.
    5. Transfer the extracted data to your regional Ex Libris FTP server.
    These steps are described in detail below.

    Downloading and Installing the AutoExtract Package

    The following section describes how to download and install the AutoExtract package.
    To download and install the AutoExtract package:
    1. Log on to your local SFX instance on your SFX server (for example, sfxlcl41, or other local instance).
    2. Enter the following command to create a directory in which to store the zip file:
      >> mkdir /exlibris/ftp_from_exlibris/sfx2alma_migration  
      You may need to create the ftp_from_exlibris subdirectory first, i.e.: 
      >> mkdir /exlibris/ftp_from_exlibris
    3. Download the package from Ex Libris FTP server via FTP as described in the email sent from Ex Libris.
    4. Enter the following command to change the directory as the local user to the sx directory:
      >> sx
      (Or: >> cd $SFX_HOME/$SFX_INST/)
    5. Move the package from /exlibris/ftp_from_exlibris/sfx2alma_migration to the sx directory of the local SFX user.
      >> cp /exlibris/ftp_from_exlibris/sfx2alma_migration/ .
    6. Enter the following command to unpack the zip file:
      >> unzip
    This unpacks the AutoExtract package and puts its constituents into their designated places in the SFX installation.
    • If you want to run the auto extract process several times (for test and for productive load for example, check if there is a new version of the package available. If so, proceed with the new package as described above.
    • If you get the message when running the unzip command, answer with A to replace the files from the old package with the ones from the new package.
      replace admin/kbtools/ [y]es, [n]o, [A]ll, [N]one, [r]ename:

    Running the Menu

    The steps of the AutoExtract package are driven by a menu.
    To run the menu:
    1. Log on to your local SFX instance on your SFX server.
    2. Enter the following command to move to the directory with the migration menu:
      >> da
      (or:>> cd $SFX_HOME/$SFX_INST/admin/)
      >> cd kbtools
    3. Enter the following command to start the menu:
    The menu is displayed:
    SFX Migration Menu
        SFX base directory : /exlibris/sfx_ver/sfx4_1
        SFX Instance code : sfxlcl41
    1. Extract SFX data
    2. Transfer extracted data
    0. Exit
    Please select [0]:

    Extracting and Converting the Data

    To extract your SFX data and convert it into an Alma supported format:
    1. Select 1. Extract SFX data to retrieve the data from the SFX database.
      If you ran the extraction before and data is still in the export directory, the following message is displayed:
      There appears to be data from a previous extraction in the directory.
      If you continue, this old data will be deleted.
      Do you want to continue? (y/n): [n]
    2. Answer y to delete the data and continue with the extraction process. Answer n, to stop the extraction process and move the old data to a different location, if you do not want to delete it.
    When running the above option within a multi-organizational (institutes/campuses) environment, a menu similar to the one below is displayed that allows you to specify the institution or group for which the migration should be carried out.
    Select Default institute unless you are a multi-organizational site:
    Institutes and/or groups have been defined in the instance.
    Choose institute or group for which the migration file should be created:
    1 All institutes defined in the instance
    2 All institutes and groups defined in the instance
    3 Default institute
    4 walnut
    5 peanut
    6 almond
    Please select [1-6,q]:
    After choosing the relevant numbered option, the process begins.

    Monitoring the Extraction Process

    The log is displayed on the screen and is saved in the following location:
    The process displays the following message:
    Start exporting active object portfolios in MARC XML format
    There will likely be no further output for up to 2 hours, depending on data size and the server strength, so do not close the terminal window or interrupt the process. If you do so, no data will be extracted and you will have start over again.
    If you get the following message, the extraction process has completed successfully. Pressing a key leads you back to the menu.
    Started packaging files
      Packaging files to:
      Packaging files to: sfx2alma_migration_r.49EXL_sfxlcl41_20151100_2015-03-20_10-50-19.tar
      Removing files
    Finished packaging files
    SFX data extraction finished
    Press any key to continue
    If you encounter any problems, contact your Ex Libris project manager.

    Transferring the Extracted Data to Ex Libris

    At the end of the extraction, the processed data can be found in the directory on the SFX server:
    At this point, the extracted data is ready for uploading to the Ex Libris FTP. Verify that FTP is open to your region’s FTP server before uploading.
    To upload the extracted data to the Ex Libris FTP:
    1. Select 2. Transfer extracted data from the SFX Migration Menu.
    2. Select the FTP server to which the data will be transferred, according to your region:
      Select the ftp server by the optional regions:
      1. APAC
      2. EUR
      3. USA
      4. CANADA
      5. CHINA
      Please select your region:
    3. You are asked for your username and password. Enter your SalesForce credentials.
    Inform Ex Libris when the data transfer process completes.
    • The data is transferred securely using SFTP.
    • The data transfer process can take up to several hours to complete, depending on the size of your data and your Internet connection speed. The functioning of SFX is not affected by this process running in the background, and your normal work in SFX can proceed in parallel. If the process does not complete within 24 hours, contact Ex Libris.
    The addresses of Ex Libris FTP servers are:
    • APAC:
    • EUR:
    • USA:
    • Was this article helpful?