Creating and Managing RSS Feeds

Creating and Managing RSS Feeds

TARGETconnect allows you to create RSS feeds based on searches you make in the system - this means you can tailor the exact content that will appear in your feeds. You can also choose which fields should appear as part of the feed.

This guide will take you through:
  1. Creating a Search
  2. Creating the Feed Definition
  3. Output Format
All RSS feeds require a saved search to use as the basis for the content of the feed. This can be achieved by:
  1. Navigate to the operator event or vacancy management search page.
  2. Enter any search filters as required
  3. Tick the 'Save this search' option at the bottom.
  4. Enter an identifying name for the search - this name will appear in the dropdown later when creating the feed. Optionally, enter a description.
  5. Tick the 'Share this search' option - if this is not ticked, it will not appear on the list of available searches when creating the feed.
Alert
A search marked as Shared does not allow other operators to use the saved search - it will still be restricted to the account that created it. It does allow other operators to select it as the basis for a feed definition - i.e. the dropdown is populated from all relevant saved searches marked as shared

Creating the Feed Definition

  1. Navigate to Maintenance -> Manage feeds
  2. Click 'Create new feed' (top-right of the page), or click 'Edit' on an existing feed to update it
  3. Fill out the fields as required:
    1. Feed entity - Select whether to create a Job or Event based feed. The saved search list will populate once you select an option here.
    2. User type - This determines where the links for the generated feed point to. Most useful is 'Student/Graduate/User', which will generate leap links usable by all those user types.
    3. Feed name - This will be part of the URL used to access the feed, allowing you to have something meaningful. This does mean that any entered text must be valid for URLs, so generally must be plain text with no spaces.
    4. Feed title - A more descriptive name for what the feed represents and will be visible to those accessing the feed directly.
    5. Feed description - An optional description for more complex feeds. Will be visible to those accessing the feed directly.
    6. Feed link - An optional link that will show to those accessing the feed directly and is associated with the feed itself rather than the individual items in the feed.
    7. Feed type - Allows you to choose between different RSS versions, or ATOM feeds if appropriate. If unsure, the default (rss_2.0) is likely the most appropriate.
    8. Saved search - If the 'Creating a search' steps above have been followed, then any searches relevant to the selected 'Feed entity' will appear in this list. Select the saved search you wish to be used to populate the feed with data.
    9. Sort field / Sort order - Determines which order the feed entities will appear - e.g. 'Expiry Date' and 'Descending' will make those jobs with an expiry date furthest in the future appear at the top.
    10. Secure feed - If you wise the feed to be protected (useful if it's only supposed to be accessed via internal web services), checking this option will require a security token to be present in the URL to access the feed. You can regenerate the token at any time, without otherwise affecting the feed. Regenerating the token will invalidate any previous URLs used to access the feed.
    11. Active - Only active feeds are accessible. Deactivate a Feed will prevent any data being retrieved, and also will not by default appear in the feed list.
      4. Select the fields you wish to appear as part of the feed. They will be shown in the order selected. The 'Show       field name' option determines whether the label in included in the output - for example, you can omit this for       job/event descriptions
      5. Click 'Create feed'. The URL that the feed is accessible from will be shown in the success message at the top of       the page.

Output Format & HTML

The feed is generated according to the relevant specification (depending on which type of feed is selected). All information appears in the 'description' standard component, with the fields separated with HTML.

Each item is wrapped in a <span> tag, with a class of 'feed-entry'. There is an additional class depending the field used (e.g. 'entry-profile' for a job description field). Each field is separated with a standard <br> tag.

If the label is included with a field, then within the wrapping <span> tag are further spans, one wrapping the label and one wrapping the field value.

e.g.:

  1. <span class="feed-entry entry-profile">Test description for a test job.</span>
  2. <br />
  3. <span class="feed-entry entry-dynamicstringslc_employer">
  4. <span class="feed-entry-label">Employer Name</span>: <span class="feed-entry-value">Test Organisation</span>
  5. </span><br />
  6. <span class="feed-entry entry-expireDate">
  7. <span class="feed-entry-label">Expiry Date</span>: <span class="feed-entry-value">Tue 22 Dec 2015</span>
  8. </span>