Skip to main content
  • Subscribe by RSS
  • ExLibris Dev

    Exporting Records

    Alma enables you to export (publish) records using several methods. Most of these methods are done by configuring publishing profiles.
    To exclude records with specific process types from being published using these methods, see Excluding Resources with Specific Process Types from Publishing.

    Configuring Publishing Profiles

    To configure publishing profiles, you must have one of the following roles:
    • Catalog Administrator
    • General System Administrator
    Alma lets you configure publishing profiles for RSS feeds, Primo, Primo Central, Google Scholar, OCLC, COPAC, Libraries Australia, and PubMed.
    You configure publishing profiles from the Publishing Profiles page (Resource Management > Resource Configuration > Configuration Menu > Record Export > Publishing Profiles).
    Publishing Profiles Page
    For more information on configuring RSS feeds, see Configuring RSS.
    For more information on configuring publishing profiles, see Resource Management.

    Configuring RSS

    To set up an RSS feed, you must have one of the following roles:
    • General System Administrator
    • Repository Administrator
    • Catalog Administrator
    An RSS (Rich Site Summary) feed pushes records to the discovery interface (Primo), identifying new items published or added to the inventory. You can use this to create a new book list.
    The library items included in the RSS feed are determined by the configuration settings and relative date spans in the RSS publishing profile.
    Internet Explorer fully supports RSS. Firefox offers some support, and Chrome does not support RSS at all. To use RSS with a browser other than IE, consult the help for that browser to find an add-on or work-around.
    See Configuring RSS Feeds for New Book Lists for an “Ask the Expert” session on this functionality (40 mins).

    New RSS Feed Workflow

    Creating a new RSS feed includes the following steps:
    1. Create a physical items set (see Saving Queries)
      Use this step to identify the set of records within which you expect to locate your list of new books. You will need this set name when configuring the RSS publishing profile.
    2. Create the RSS discovery URL (see Creating the RSS Discovery URL)
    3. After you have identified all the parts and created the RSS discovery URL that you need to use for your new book list process, enter the URL in the rss_discovery_url parameter on the Customer Parameters Mapping Table page (Administration > General Configuration > Configuration Menu > General > Other Settings).
    4. Create an RSS publishing profile (see Configuring an RSS Publishing Profile)
    5. Create the RSS feed URL (see Creating the RSS Feed URL)
    6. Optionally, confirm that new books have been added/received to your database (within the set that you saved above).
    7. Confirm that the RSS publishing profile successfully completed processing on the Monitor Jobs page (see Viewing Completed Jobs).
    8. Use the RSS feed URL to view the new book list by entering the URL into a browser and viewing the results in Primo. See The RSS Feed Job.

    Configuring an RSS Publishing Profile

    To implement RSS:
    1. Configure a publishing profile that includes a definition of new that is between 90 and 2 days ago (see the Max number of days ago and Min number of days ago settings described in the procedure below related to the definition of new).
    2. Create and/or select a physical item set to be used with the RSS publishing profile.
    3. Define a new customer parameter, rss_discovery_url (Administration > General Configuration > Configuration Menu > General Configuration > Other Settings), that links to Primo at the institution level. See Creating the RSS Discovery URL.
    The RSS feed can then be run (see The RSS Feed Job).
    Alma’s RSS feed pertains to physical items only.
    To configure the RSS feed:
    1. From the Resource Management Configuration page (Resource Management > Resource Configuration > Configuration Menu), click Publishing Profiles in the Record Export section. The Publishing Profiles page appears, listing all publishing profiles.
    2. Click Add Profile and select the RSS option. The Publishing Profile Details page appears to a blank RSS profile.
      Publishing Profile Details for RSS
    3. Configure the RSS publishing profile using the table below.
      RSS Publishing Profile
      Field Description
      Profile Details
      Profile name The unique name of this RSS feed publishing profile. Used to identify the profile on the list of Publishing Profiles page.
      Profile description More information about the profile that appears on the Publishing Profiles page.
      • Active (yellow check mark), meaning it is in use or can be used, or
      • Inactive (clear check mark), meaning it is unable to be used at present.
      Scheduling When you want to run this publishing profile.
      Email Notifications Which users and email addresses receive email notifications when an RSS job completes. Click to open the Email Notifications for Scheduled Jobs page. Select whether to send the notifications for successful jobs and/or jobs that contain errors.
      RSS Feed Parameters
      RSS feed name The name used to generate the link to the feed. Do not use spaces in the name.
      RSS feed title The name of the profile in the Publishing Profiles list.
      This also appears in the RSS feed results.
      RSS feed description A description of the profile that appears in the Publishing Profiles list.
      This also appears in the RSS feed results.
      Display Location Name Whether to include the full location name in the output or only the location code.
      Language A drop-down list from the languages code table. The default is empty. Once a value is selected, it becomes the default on subsequent uses of the profile.
      Select Population
      Set name The set of physical items that the RSS action is applied to. Click the arrow to open a list of physical item sets to browse or search, then select one.
      Max number of days ago The maximum number of days past to look for new items for the feed. New is determined by the item’s Receiving date identified on the Physical Item Editor page.
      The default number of days is 60. This number cannot exceed 90.
      Min number of days ago The minimum number of days past to look for new items. The default is 2, and two days is the minimum to ensure synchronization with the Primo. This number cannot exceed the Max number of days ago.
    4. Click Save. The Publishing Profile list page appears with the new RSS feed publishing profile listed.

    Creating the RSS Discovery URL

    The RSS discovery URL has several component parts. Use the following template to define your RSS discovery URL:
    http://<primo domain>/primo_library/libweb/action/<institution>&vid=<view>&tab=<tab code>&indx=1&bulkSize=10&query=any,contains,<value>
    An example of a functional RSS discovery URL may look something like:,contains,primo_alma@@ALMA_IND@@
    This template can be divided into the following components some of which you need to locate and other parts that are provided:
    Primo Tab Code
    Scope Name (Primo Back Office)
    • Primo domain,contains,primo_alma@@ALMA_IND@@
      This can be obtained from the Primo URL.
    • RSS discovery URL string provided (1),contains,primo_alma@@ALMA_IND@@
    • Institution code,contains,primo_alma@@ALMA_IND@@
      This is the Primo institution code not the Alma institution code. This can be located in the Primo back office by editing the Primo institution (Primo Home > Ongoing Configuration Wizards > Institution Wizard). For more information, see the Primo Back Office Guide.
    • vid (view ID),contains,primo_alma@@ALMA_IND@@
      Use the vid value that you find in the Primo URL.
    • View tab,contains,primo_alma@@ALMA_IND@@
      This is the tab code name (case sensitive) for the desired view in the Primo back office at Primo Home > Ongoing Configuration Wizards > Views Wizard as shown below. For more information, see the Primo Back Office Guide.
    • Scope name within the selected tab,contains,primo_alma@@ALMA_IND@@
      You identify the scope name to be used from the ones defined in the Primo back office for the view tab you identified in the previous component. For more information, see the Primo Back Office Guide.
    • RSS discovery URL string provided (2),contains,primo_alma@@ALMA_IND@@
    • sourceid,contains,primo_alma@@ALMA_IND@@
      The sourceid can be found in the Primo back office Data Sources Configuration (Primo Home > Ongoing Configuration Wizards > Pipe Configuration Wizard >Data Sources Configuration) or by viewing the <sourceid> in a Primo PNX record. For more information, see the Primo Back Office Guide.
      Primo sourceid
      Primo sourceid from a PNX Record
    • RSS discovery URL string provided (3),primo_alma@@ALMA_IND@@
      Once you have defined your RSS discovery URL, you can enter it in the rss_discovery_url parameter that is located on the Mapping Table page of Other Settings (Administration > General Configuration > Configuration Menu > General Configuration section).

    Creating the RSS Feed URL

    The RSS feed URL is used to retrieve the records in the RSS feed. After each time that the RSS publishing job is run, the RSS feed includes records in the results with items that have a receiving date that meets the criteria for minimum/maximum number of days ago that you set in the RSS publishing profile. These records make up the list of new books for your new book list. Patrons may sign up for the RSS feed or a link to the RSS feed URL may be placed in Primo or on another library web page.
    The following is an example of an RSS feed URL:
    http://<Alma domain>/rep/getFile?institution_code=EXLDEV1_INST&file=library_science_RSS_name&type=RSS
    The RSS feed URL is made up of the following component parts (using the example above):
    • Alma URL (see Your Alma Domain Names)
      <Alma domain
    • RSS feed URL string provided (1)
    • Alma institution code
    • RSS feed URL string provided (2)
    • RSS feed name as defined in the RSS publishing profile
      RSS Feed Name from the RSS Publishing Profile
    • RSS feed URL string provided (3)

    The Publishing RSS Feed Job

    After you have completed the RSS feed publishing profile, the Publishing RSS feed job runs according to the schedule defined in the profile.
    To view the progress of the job, find it using the Publishing filter on the Monitor Jobs page (see Viewing Running Jobs and Viewing Completed Jobs) or select Actions > History for the RSS profile on the Publishing Profile page. For completed jobs, select Actions > Report to open the Job Report page.
    In addition to the files created as a result of the RSS feed job Alma generates a summary link (displayed on the Job Report page) for each RSS job in the following format:
    http://<Alma domain>/rep/getFile?institution_code=[Alma Institution Code]&file=[RSS feed name]&type=RSS
    This is the same URL format described in Creating the RSS Feed URL. To display the results of the RSS feed publishing profile, that is, the new book list, click the link provided on the Job Report page, or copy/paste the RSS feed URL that you created in the section Creating the RSS Feed URL into a browser.
    RSS Feed URL Entered into a Browser
    Either method opens a page similar in format to the figure below that contains a list of items matching the date span criteria that you provided in the publishing profile. This is your new books list.
    RSS Feed Results/New Books List
    When you click the link for one of the records in the RSS feed results list (the new books list), the item opens in your discovery tool/Primo as shown in the figure below.
    New Item Displayed in Primo
    • Was this article helpful?
    // feedback widged