Creating and Using Feeds

This chapter discusses how to:

Click to jump to parent topicDefining and Publishing Feeds

This section presents the business process flow for feeds and discusses how to:

Click to jump to top of pageClick to jump to parent topicPages Used to Publish Feeds

Page Name

Definition Name

Navigation

Usage

Publish Feed Definition

PTFP_PUB_AS_FEED

Click the Publish as Feed link from a data type content page.

Define feed security options, enter optional feed properties, and access advanced options.

Advanced Feed Options

PTFP_PUB_AS_ADVOPT

Click the Advanced Options link from the Publish Feed Definition page.

Enter advanced option values that are specific to the feed.

Publish as Feed

PTFP_PUB_AS_LIST

Click the Publish button from the Publish Feed Definition page.

Review, edit, or add feed definitions for this item.

Publish Feed Definition to Sites

PTFP_PUB_AS_SITES

Click the Publish Feed to Other Sites link from the Publish Feed Definition page.

Select additional sites to publish the feed.

Click to jump to top of pageClick to jump to parent topicFeed Publishing Business Process Flow

This diagram illustrates the business process flow for developing, administering, and viewing feeds.

Click to jump to top of pageClick to jump to parent topicPublishing Feeds

To publish the feed, you access the Publish as Feed pages.

Each feed data type has its own set of properties necessary to define feed details. This table lists the delivered feed data types and navigation path to the publish pages.

Feed Data Type

Navigation

WORKLIST

Worklist, Worklist or Worklist, Worklist Details

PSQUERY

Reporting Tools, Query, Query Manager

GENERICFEED

PeopleTools, Feeds, Define IB Generic Message Feed

FEED

PeopleTools, Feeds, Define Feed Data Types

Click to jump to top of pageClick to jump to parent topicDefining Feed Properties

When you click the Publish as Feed link, you then must define feed properties such as the feed title, security, and other options.

Access the Publish Feed Definition page (click the Publish as Feed link).

Feed Properties

Feed Title

This field is pre-populated based on the selected content item information when you create a new feed definition. You can edit the field. Enter a maximum of 30 characters.

Description

Enter no more than a 255-character description of the feed.

Advanced Options

Click the Advanced Options link to access the Advanced Options page for the data type. Advanced options vary by feed data type.

Publish

Click the Publish button to publish the feed.

Additional Feed Properties

Not all readers display all properties. This table describes the additional feed properties that some feed readers process and display.

Note. Values entered in these fields replace the default feed property values defined at the feed data type level.

See Feed Document Properties.

See Defining the Feed Data Type.

Copyright

Enter a copyright date to be included in the XML.

Logo

Enter a URL to the logo to be included in the XML, for example, http://peoplebooks.peoplesoft.com:8700/PSOL/pt/img/logo.gif.

Icon

Enter a URL to an icon to be included in the XML, for example, http://peoplebooks.peoplesoft.com:8700/PSOL/pt/img/icon.gif.

Author Name

Enter an author to be included in the XML.

Author Email

Enter an author email address to be included in the XML.

Contributor Name

Enter a contributor to be included in the XML.

Contributor Email

Enter a contributor email address to be included in the XML.

Feed Security Options

This table describes the feed security options:

Note. Query feeds apply security by using the Advanced Options page.

Worklist feeds support real-time security only and Feed Security options do not appear for Worklist feeds.

See Understanding Worklist Feeds.

See Defining Advanced Feed Options for Query Feeds.

Publish as Public

Select to make the feed available for public access.

Publish with Selected Security

Select to make the feed available based on the viewer's role-based permission lists.

When you select this type of security, the Selected Security grid appears, enabling you to set role and permission list security.

Note. User-based permission lists, such as the Primary Permission List, are not applied with this type of security.

Publish with Realtime Security

Select to have the system check the data source object to determine whether the viewer has access to the feed in real time. This option is the default for new feed definitions.

Sync with Data

Click this button to explicitly sync the feed permission with the selected feed data permissions. This button appears for existing feed definitions only when you select the Publish with Selected Security option.

Selected Security

Type

Select either Role or Permission List security.

Name

Enter the name of the permission list or role that has access to the feed.

Click to jump to top of pageClick to jump to parent topicDefining Advanced Options

Advanced options differ by data type.

Access the Generic IB Message Feed Advanced Feed Options page.

Max Number of Entries

Enter the maximum number of entries that the feed should return to the user. Enter 0 for unlimited entries. The framework restricts the output to 300 entries.

Note. This value (300 entries) can be configured in the PTFP_MAX_ROW_LIMIT field in the PS_PTFP_OPTIONS table. If the Max Number of Entries specified is 0 or greater than the PTFP_MAX_ROW_LIMIT, then the output is limited to the value in the PTFP_MAX_ROW_LIMIT field. If the PTFP_MAX_ROW_LIMIT is 0 or does not exist, then the output is limited by Max Number of Entries.

See Also

Defining Advanced Feed Options for Query Feeds

Defining Worklist Advanced Feed Options

Click to jump to top of pageClick to jump to parent topicPublishing Feeds to Additional Sites

You can publish the feed to any site listed in the additional sites list.

Access the Publish Feed Definition to Sites page:

Target Sites

Select

Select this check box to publish the feed definition to this site.

Site Name

Displays the valid sites to which you can publish the feed. This field is display only.

Publish Feed

Click to publish the feed to the additional sites.

Click to jump to parent topicPublishing a List of Feeds Feed

List of Feeds feed is a feed that contains a list of all available feeds of a specific feed data type. When you access the list of feeds feed, you see only the feed that you are authorized to view. You can publish list of feeds feed by using the FEED data type.

To publish a list of feeds feeds:

  1. Select PeopleTools, Feeds, Define Feed Data Types.

  2. Select the data type for which to produce the list of feeds.

  3. Click the Publish as Feed link.

  4. Click the feed definition to view the feed.

    See Defining and Publishing Feeds.

Click to jump to parent topicAccessing Feeds

You can access feeds by using:

Click to jump to top of pageClick to jump to parent topicUsing the My Feeds Page

Access the My Feeds page.

Additional Instructions

The additional instructions section describes how to use the My Feeds page.

Search Feed Definitions

Data Type

Select from the following feed data types:

List of Feeds returns a list of all feed list feeds to which the user has access.

Query Feeds returns a list of query feeds to which the user has access.

Generic Feeds returns a list of Integration Broker generic feeds to which the user has access.

Worklist Feeds returns a list of worklist feeds to which the user has access.

All Data Types returns a list of all feeds to which the user has access.

Keyword

Enter a keyword to narrow the search criteria. Keywords search the Feed ID, Feed Title, and Description fields, and are not case sensitive.

Search In

Select from the following sites to search for feeds:

Current Site: Select this option to search in the viewer's current site only. This value is the default.

All Sites: Select this option to search every site for available feeds.

Search

Click the Search button to return the list of available feeds that satisfy the search criteria that you enter.

Reset

Click the Reset button to clear all fields, clear the feed list, and return to a blank search.

Export Feed List

Click this link to export the current feed list in the Feed Definitions grid in a *.opml file of OPML 2.0 format. OPML files can be imported in a feed reader, and the user will be able to subscribe to the list of feeds in the exported file.

This link is visible only when a search returns one or more values.

Feed Definitions

This grid lists the feeds that match the search criteria and that the viewer has permissions to view.

Click to jump to top of pageClick to jump to parent topicUsing Related Feeds Hover Menus

You can view the feeds of a particular data type to which you have access through the related feeds hover menu on a page.

Notice the hover menu extending to show the query feeds that are available to this user:

Note. The hover menu is inactive when no feeds are available for that particular feed data type. Inactive hover menus can be hidden if you set the PTFP_SHOW_IA_MENU field to 0 in the PS_PTFP_OPTIONS table.

Click to jump to top of pageClick to jump to parent topicUsing the Get Feed List Service Operation

The GetFeedList service operation (PTFP_GETFEEDLIST) returns a list of feeds managed by the Feed Publishing Framework using the OPML format. Users can save this file to the desktop, and share the file with other users who might want to access the same list. You can also use this file to import feeds into a feed reader.

In the file, feeds are organized in folders based on their feed data type. Only feeds visible to authenticated user of the request are returned. The Get Feed List operation provides capability to query feeds through the use of operational query parameters, the same way as the My Feeds component. Some examples of the parameters are:

Parameter

Description

Example

PTFP_DATA_TYPE

The data type being queried.

To search for the PS Query feed type, use this parameter: PTFP_DATA_TYPE=PSQUERY.

PTFP_FEED_KEYWORD

The keyword being used in the query. The keyword searches the feed title, description, and ID.

To search feeds whose name contains User string, use this parameter: PTFP_FEED_KEYWORD=User.

PTFP_DSS_COUNT

The data source setting name/value pair parameter count.

To specify the query string when it contains one pair of the data source setting name and value, use this parameter: PTFP_DSS_COUNT=1.

PTFP_DSS_NAMEn

The data source setting name, where n is an integer beginning with 1.

To specify the first data source setting name, use this parameter: PTFP_DSS_NAME1=QRYNAME.

PTFP_DSS_VALUEn

The data source setting value, where n is an integer beginning with 1.

To specify for the first data source setting value, use this parameter:PTFP_DSS_VALUE1=MESSAGES_FOR_MSGSET.

PORTAL_NAME

The portal being searched if you have multiple portals. The system searches all sites if this parameter is not specified.

To search only the EMPLOYEE portal, use this parameter: PORTAL_NAME=EMPLOYEE.

LANGUAGE_CD

The language of the feed being queried.

To search the feed in Canadian French, use this parameter: LANGUAGE_CD=CFR.

Note. PeopleSoft PeopleTools provides one Get Feed List service. You may develop your own services for specific feed data types.

Example of .opml File Exported From the My Feeds Page

OPML refers to Outline Processor Markup Language. It is the protocol used for exchanging feed lists between feed readers and aggregators. This is an example of an opml file:

<?xml version="1.0"?> <opml version="2.0"> <head> <dateCreated>Mon, 04 May 2009 16:32:27 GMT</dateCreated> <dateModified>Mon, 04 May 2009 16:32:27 GMT</dateModified> <ownerName>QE User</ownerName> <title>Feed Search Results</title> </head> <body> <outline category="IB Generic Message Feeds" description="Generic Operation"⇒ text="IB_GENERIC" title="ADMN_IB_GENERIC" type="rss" xmlUrl="http:⇒ //buffy.us.oracle.com:8920/PSIGW/HttpListeningConnector/feeds/GetScheduled⇒ Feed?FeedID=IB_GENERIC.V1&amp;ChildFeedID=ADMN_IB_GENERIC&amp;S=P&amp;PORTAL_NAME=⇒ EMPLOYEE&amp;NODE_NAME=QE_LOCAL"/> <outline category="PS Query Feeds" description="Dimension Control Table" text=⇒ "CM_DIM_CTRL_TBL" title="ADMN_CM_DIM_CTRL_TBL" type="rss" xmlUrl="http:⇒ //buffy.us.oracle.com:8920/PSIGW/HttpListeningConnector/feeds/RealtimeQuery⇒ Feed?FEED_ID=ADMN_CM_DIM_CTRL_TBL&amp;PORTAL_NAME=EMPLOYEE&amp;NODE_NAME=QE_LOCAL"⇒ /> <outline category="PS Query Feeds" description="Message Set" text="CD_MSGSET"⇒ title="ADMN_CD_MSGSET1" type="rss" xmlUrl="http://buffy.us.oracle.com:8920/PSIGW⇒ /HttpListeningConnector/feeds/RealtimeQueryFeed?FEED_ID=ADMN_CD_MSGSET1&amp;PORTAL_⇒ NAME=EMPLOYEE&amp;NODE_NAME=QE_LOCAL"/> <outline category="IB Generic Message Feeds" description="User Profile" text=⇒ "User Profile Feed" title="ADMN_USER_PROFILE" type="rss" xmlUrl="http:⇒ //buffy.us.oracle.com:8920/PSIGW/HttpListeningConnector/feeds/GetScheduled⇒ Feed?FeedID=USER_PROFILE.VERSION_84&amp;ChildFeedID=ADMN_USER_PROFILE&amp;PORTAL_⇒ NAME=EMPLOYEE&amp;NODE_NAME=QE_LOCAL"/> <outline category="List of Feeds" description="A feed of this data type⇒ contains data of the specified PS Query." text="PS Query Feeds" title="ADMN_PS_⇒ QUERY_FEEDS" type="rss" xmlUrl="http://buffy.us.oracle.com:8920/PSIGW/Http⇒ ListeningConnector/feeds/GetRealTimeFeed?FEED_ID=ADMN_PS_QUERY_FEEDS&amp;S=⇒ P&amp;PORTAL_NAME=EMPLOYEE&amp;NODE_NAME=QE_LOCAL"/> <outline category="List of Feeds" description="A feed of this data type⇒ contains worklist items of the current user." text="Worklist Feeds" title="ADMN_⇒ WORKLIST_FEEDS" type="rss" xmlUrl="http://buffy.us.oracle.com:8920/PSIGW/Http⇒ ListeningConnector/feeds/GetRealTimeFeed?FEED_ID=ADMN_WORKLIST_FEEDS&amp;S=⇒ P&amp;PORTAL_NAME=EMPLOYEE&amp;NODE_NAME=QE_LOCAL"/> <outline category="List of Feeds" description="A feed of this data type⇒ contains list of published feeds of the specified data type." text="List of⇒ Feeds" title="ADMN_LIST_OF_FEEDS" type="rss" xmlUrl="http:⇒ //buffy.us.oracle.com:8920/PSIGW/HttpListeningConnector/feeds/GetRealTimeFeed?FEED_⇒ ID=ADMN_LIST_OF_FEEDS&amp;S=P&amp;PORTAL_NAME=EMPLOYEE&amp;NODE_NAME=QE_LOCAL"/> <outline category="PS Query Feeds" description="User ID's Access Activity"⇒ text="User Access Activity" title="ADMN_PT_SEC_ACCESSLOG_USER" type="rss" xmlUrl=⇒ "http://buffy.us.oracle.com:8920/PSIGW/HttpListeningConnector/feeds/Realtime⇒ QueryFeed?FEED_ID=ADMN_PT_SEC_ACCESSLOG_USER&amp;PORTAL_NAME=EMPLOYEE&amp;NODE_⇒ NAME=QE_LOCAL"/> <outline category="PS Query Feeds" description="Hierarchy Map Table" text="CM_⇒ HIER_MAP_TBL" title="ADMN_CM_HIER_MAP_TBL" type="rss" xmlUrl="http:⇒ //buffy.us.oracle.com:8920/PSIGW/HttpListeningConnector/feeds/RealtimeQuery⇒ Feed?FEED_ID=ADMN_CM_HIER_MAP_TBL&amp;PORTAL_NAME=EMPLOYEE&amp;NODE_NAME=QE_LOCAL"⇒ /> <outline category="PS Query Feeds" description="Attribute mappings" text="CM_⇒ ATTRIBUTES" title="ADMN_CM_ATTRIBUTES" type="rss" xmlUrl="http:⇒ //buffy.us.oracle.com:8920/PSIGW/HttpListeningConnector/feeds/RealtimeQuery⇒ Feed?FEED_ID=ADMN_CM_ATTRIBUTES&amp;PORTAL_NAME=EMPLOYEE&amp;NODE_NAME=QE_LOCAL"/> <outline category="Worklist Feeds" description="Worklist notifications" text=⇒ "Worklist Notification" title="ADMN_WORKLIST_ITEMS" type="rss" xmlUrl="http:⇒ //buffy.us.oracle.com:8920/PSIGW/HttpListeningConnector/feeds/GetRealTimeFeed?FEED_⇒ ID=ADMN_WORKLIST_ITEMS&amp;PORTAL_NAME=EMPLOYEE&amp;NODE_NAME=QE_LOCAL"/> </body> </opml>

Click to jump to parent topicViewing Feeds

You can view feeds directly in the browser or by using a feed reader program.

To view feeds:

  1. Click the feed link.

    The feed will open in the browser.

  2. Alternatively, paste the URL into a feed reader.

This is an example of a feed in the browser: