Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

RSS Feed management can be found under the system & database settings menu in the Admin application. Using RSS feeds allows you to embed content into the Portal from external sources and internal saved searches.


To start click Create New Widget at the top of the page, this will open the below page.

Start by entering a Name for your RSS widget, followed by a Description. The name will be shown in the header of your widget when displayed in the portal. Description is only visible when viewing the RSS feed via its raw XML format.

Sorting Rule defines the sorting order of the feed (ascending/descending) by default the feed is sorted by date.

Auto Scroll will enable automatic scrolling of the feed several sends after the feed has loaded. Users can hover an item to pause the scroll or manually scroll faster if required.

Show Image will display images in the feed if available from your chosen sources.

Warning
We advise not to include images if you are returning content from a saved search, this is because most cover image providers impose hourly and daily limits on the number of covers which can be displayed, these limits are often very quickly reached when using RSS feeds. This does not apply if you upload your own cover images.

Group by Source If returning multiple feeds into a single widget it is possible to group them by source using this option. The order of sources is set based on the order in which they display in the RSS links grid. The order of these can be changed using the blue stack icon.

There are two ways to add links to a widget

  1. via a saved search already setup in your system
  2. via a third party RSS feed.

    Tip
    It is possible to combine saved search feeds and third party feeds into a single widget.



Adding a saved search feed 

Using the toggle in the blue header switch to Yes, then using the drop down select the saved search you wish to add and click the blue Add button. Your saved search will be shown in the grid below, you may add multiple saved searches if required.

After adding your first saved search six fields will appear above the RSS links box. by typing into each box you are able to add fields to map into your RSS feed. Multiple fields can be added.

Note
Adding multiple fields will require use of a custom XSL file to be uploaded.


Title - This will act as the feed item title and also a link to the full RSS item.

Description - This will be additional information you wish to display about the feed item below the title.

Author - This is optional but can be used to identify the source or author of the item.

Category - This is optional but can be used to tag the item with any additional information such as keywords.

Enclosure - this will allow any attached files or images to be shown in the item details.

Publication Date - This indicates the date field which will be used for sorting, it can also be included in the item details if required.

Adding an external RSS feed

Using the toggle in the blue header switch to No, you will then see four fields listed.

Title and description are optional and usually should not be set for external feeds.

URL is required as this is the feed URL for the third party RSS.

After entering the URL click Add. This will add your external feed to the grid along with any others you have added.



Warning

While there is no hard limit for the source that can be added it is important to keep in mind the performance impact a widget can have on a system, especially if you are attempting to return a lot of records from multiple sources. For this reason limits are set for the maximum number of records which are returned within a widget. These limits can be found in System configuration maintenance.


After adding all of your feed links you can save the widget at the bottom of the page. This will apply a default styling to your widget once added to the portal.

Widget Customisation

Custom RSS Schema can be uploaded using the RSS Scheme section in the widget. You can click into the area and select the file to upload when prompted or drag & drop your file into the area.

After uploading a custom schema it will be shown only until saved, afterwards the blue header will identify if the widget uses the default schema or a custom one i.e  [Default Global Scheme In Use] or [Custom Scheme In Use]

Tip

Contact our helpdesk for assistance in modifying your widget style & data presentation.

Tip

If you want to apply the same custom style to all of your widgets you can apply this from the RSS maintenance page using the download/upload XSL buttons.