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

    RSS Publishing

    Translatable
    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.

    New RSS Feed Workflow

    Creating a new RSS feed includes the following steps:
    1. Create a physical items set (see Saving and Reusing Search Queries) 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.

    Only logical sets can be used with the RSS Profile. Itemized sets will not be listed when running the profile. 

    1. Create the RSS discovery URL (see Creating the RSS Discovery URL).
    2. 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 rss_discovery_url (see Configuring Other Settings).
    3. Create an RSS 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 Configuring an RSS Publishing Profile below).
    4. Create the RSS feed URL (see Creating the RSS Feed URL)
    5. Optionally, confirm that new books have been added/received to your database (within the set that you saved above).
    6. Confirm that the RSS publishing profile successfully completed processing on the Monitor Jobs page (see Viewing Completed Jobs).
    7. 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 Viewing Scheduled Jobs.

    Configuring an RSS Publishing Profile

    To configure the RSS feed:
    1. Open Resources > Publishing > Publishing Profiles.
    2. Select Add Profile and select the RSS option. The Publishing Profile Details page appears to a blank RSS profile.
    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.
      Status
      • 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. Select 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.
      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.
      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.

      RSS version 2.0

      Select this checkbox to publish RSS feeds using RSS 2.0 XML.

      Select Population
      Set name The set of physical items to which the RSS action is applied.
      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. Select Save. The Publishing Profile list page appears with the new RSS feed publishing profile listed.

    Creating the RSS Discovery URL

    The RSS discovery URL defines the base URL that Alma uses to generate the deep links to the items listed in all of your RSS Publishing feeds.
    For Primo VE, use the following template to define your RSS discovery URL:
    http://<Primo_domain>/discovery/search?vid=<view_code>&tab=<search_slot>&search_scope=<scope_code>&query=any,contains,@@ALMA_MMS_ID@@
    An example of a functional RSS discovery URL may look something like the following for Primo VE:
    https://myprimo.exlibrisgroup.com/discovery/search?vid=MY_INST:MINES&tab=Everything&search_scope=MyInst_and_CIquery=any,contains,@@ALMA_MMS_ID@@
    For Primo, use the following template to define your RSS discovery URL:
    http://<Primo_domain>/primo_library/libweb/action/dlSearch.do?institution=<institution_code>&vid=<view_code>&tab=<tab_code>&search_scope=<scope_name>&query=any,contains,<source_code>@@ALMA_IND@@
    • Primo_domain – Specify the domain that you use for Primo's UI.
    • institution_code – Specify Primo's institution code, which is defined with the Institution Wizard in the Primo Back Office. For more details, see Institution Wizard.
    • view_code – Specify Primo's view code, which is defined with the Views Wizard in the Primo Back Office. For more details, see Configuring Primo Views.
    • tab_code – Specify the view's tab code, which is defined with the Views Wizard in the Primo Back Office. For more details, see Configuring View Tabs. If not specified, the system uses the view's default.
    • scope_name – Specify the name of the scope to which you want to search, which is defined with the Views Wizard in the Primo Back Office. For more details, see Configuring Search Scopes. If not specified, the system uses the view's default.
    • source_code – Specify the source code, which is defined with the Data Sources page in the Primo Back Office (see Configuring the Data Source). If your institution is a member of a collaborative network, leave this value blank.
    For more information on using the parameters for the Brief Search deep link, see Brief Search Deep Link in the Developer Network.
    An example of a functional RSS discovery URL may look something like the following for Primo:
    http://demo.primo.exlibrisgroup.com:1701/primo_library/libweb/action/dlSearch.do?institution=EXLDEV1_INST&vid=Alma&tab=default_tab&search_scope=Alma&query=any,contains,primo_alma@@ALMA_IND@@
    If you are using the new Primo UI and had not switched from the classic Primo UI, use the following template to define your RSS discovery URL:
    https://<Primo_domain>/primo-explore/search?institution=<institution_code>&vid=<view_code>&tab=<tab_code>&search_scope=<scope_name>&query=any,contains,<source_code>@@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 retrieves the records in the RSS feed. After each run of the RSS publishing job, the RSS feed includes records in the results with items whose receiving date is within the minimum/maximum number of days ago range 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 by selecting a link to the RSS feed URL, which has been placed in Primo or on another library web page. The following template is used to create the RSS feed URLs, which can be verified by viewing the completed job report for the RSS publishing profile:
    http://<Alma_domain>/rep/getFile?institution_code=<institution_code>&file=<RSS_feed_name>&type=RSS
    • Alma_domain – Specify your Alma domain (see Your Alma Domain Names).
    • institution_code – Specify the code that is assigned to your institution in Alma.
    • RSS_feed_name – Specify the name of the RSS feed, which is defined in the RSS publishing profile:
      RSS Feed Name from the RSS Publishing Profile
    The following is an example of an RSS feed URL:
    http://demo.alma.exlibrisgroup.com:1801/rep/getFile?institution_code=EXLDEV1_INST&file=library_science_RSS_name&type=RSS

    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 one of the below:

    For completed jobs, select Report from the row actions list to open the Job Report page.

    The job report looks as the below:
    RSS job report.png

    Counters displayed in the job report:

    • New records (P) - Number of records that actually published with the logical set criteria (Receiving date).
    • Filtered records - Not relevant here, ignore this counter. 

    In addition to the files created as a result of the Publishing 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, select 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 select 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

    Format of Published Data

    This is an example of the XML file structure:

    <rss xmlns:atom="http://www.w3.org/2005/Atom" version="2.0">
    <rss>
    <channel>
    <link></link>
    <description></description>
    <language></language>
    <item>
    <title></title>
    <link></link>
    <author></author>
    <description>
    <language></language>
    <format></format>
    <mattype></mattype>
    <pubDate></pubDate>
    <arrivalDate></arrivalDate>
    </item>
    </channel>
    </rss>

    If no physical items meet the publish criteria (according to the logical set definitions or according to the "Max number of days ago" and "Min number of days ago" defined in the Publishing Profile), the XML page built as a result of the publishing will be empty. This is an example of such an empty page:
    empty RSS report.png

    • Was this article helpful?