Aggregator portlet

From VYRE

Jump to: navigation, search
Aggregator portlet
module: Publishing module
supplier: VYRE Ltd.


The Aggregator Portlet can read RSS, RDF, and Atom feeds, and transform them via XSL. The feeds can optionally be filtered using a search query. The feed list and the feed filter can be picked up from three sources:

  1. From the portlet settings (default).
  2. From attributes of the selected item (on a display page).
  3. From attributes of the user currently logged in.

Note that 3 overrides 2 which in turn overrides 1. The aggregator portlet can retrieve feeds of different formats (RSS, RDF, Atom, etc.). It then converts all those feeds to a single format. This is done so that a single XSL style sheet can be used to transform the feeds, independent of their original format.

Edit mode

Following is a brief description of the properties in the edit mode:

  • Feed format: The single format that all feeds will be transformed to.
  • XSL stylesheet: The XSL style sheet that will be used to transform the feeds. The list of XSL is taken from the "Others" folder. This option uses Shortcut functionality.
  • Feed URLs: URLs to feeds can be entered here, separated by a line break. If the URL is invalid, then the feed will simply not be displayed.
  • Activate filtering: Turn filtering on/off.
  • Filter query: A search query for filtering the feeds. The query syntax follows the Lucene query syntax.
  • Realm: If the feed URL list and/or filter query are to be retrieved from the profile of the current user, then you first need to select a user realm.
  • User attribute to retrieve feed list from: Select a user attribute. If none is selected, or the attribute is empty, then the default will be used.
  • User attribute to retrieve filter from: Select a user attribute. If none is selected, or the attribute is empty, then the default will be used.
  • Content store: If the feed URL list and/or filter query are to be retrieved from attributes of the currently selected item, then you first need to select a store.
  • Item attribute to retrieve feed list from: Select an item attribute. If none is selected, or the attribute is empty, then the default will be used.
  • Item attribute to retrieve filter from: Select an item attribute. If none is selected, or the attribute is empty, then the default will be used.

Caching

It is a good idea to apply caching to this portlet, since some feed providers will block IP addresses that send requests to it too frequently. Note however, that if the feed settings are to be retrieved from a user profile, then caching should not be used.

See also

Personal tools