PeopleTools 8.52: Feed Publishing Framework

Creating and Using Feeds and Feed Templates

This chapter provides an overview of creating and using feeds and feed templates and discusses how to:

Publish feeds using the Feed Publishing Wizard.
Publish feeds using the Publish as Feed pages.
Create and edit feed templates.
Publish a “list of feeds” feed.
Publish feed definitions to additional sites.
Access feeds.
View feeds

Understanding Creation and Use of Feeds and Feed Templates

This section discusses:

The process flow for feed publishing and consumption.
Methods for publishing feeds.
Feed templates.

Process Flow for Feed Publishing and Consumption

The business process flow for developing, administering, and viewing feeds includes the following steps:

(Optional) The subject matter expert analyzes the requirements for new feed data types.
(Optional) The application developer develops new feeds.
1. The application developer develops the new feed data types using Application Designer.
2. The application developer adds the new feed types to the application.
The feed administrator identifies the feeds to publish.
(Optional) The feed administrator creates feed templates to aid with feed publication.
The feed administrator publishes:
1. Individual feeds.
2. “List of feeds” feeds.
The feed administrator creates and publishes feed definitions using one of the following methods:
- The four steps of the Feed Publishing Wizard.
  
  (Optional) Feed templates are used to aid in creating feed definitions.
- The Publish as Feed pages.
  
  (Optional) Feed templates are used to aid in creating feed definitions.
The application user searches for feeds and then:
1. Views the feed.
2. (Optional) Subscribes to the feed.

The following diagram illustrates this business process flow:

Business process flow for developing, administering, and viewing feeds

Methods for Publishing Feeds

The Feed Publishing Framework provides two methods for publishing feeds:

Feed Publishing Wizard.
Publish as Feed links and pages.

In a PeopleSoft system, administrative users and content owners with appropriate authorization can use either method to create, view, edit, and delete feed definitions related to a particular data source.

Feed Publishing Wizard

The Feed Publishing Wizard provides an easy to follow, four-step guide to publish feeds from any data source for the feed data types defined in the system. The Feed Publishing Wizard simplifies the creation and editing of feed definitions. In addition, the Feed Publishing Wizard:

Provides the ability to create and edit feed templates.
Allows you to specify data source parameters as personalizable—that is, as user specified or administrator specified.

See Publishing Feeds Using the Feed Publishing Wizard.

Publish as Feed Links and Pages

The Publish as Feed links and Publish as Feed pages provide another access point and mechanism for publishing feeds. The Publish as Feed links can be found on the content maintenance pages for specific types of content only. In PeopleTools, these Publish as Feed links are found on the maintenance pages for content associated with the four delivered PeopleTools feed data types: FEED, GENERICFEED, PSQUERY, and WORKLIST.

When using these publish pages, the feed administrator is not guided, but must follow a defined process for creating a feed definition.

See Publishing Feeds Using the Publish as Feed Pages.

This table lists the base feed data types delivered in PeopleTools and the navigation path to the publish pages for each data type:

Feed Data Type	Navigation
FEED	PeopleTools, Feeds, Define Feed Data Types See Publishing a List of Feeds Feed.
GENERICFEED	PeopleTools, Feeds, Define IB Generic Message Feed See Creating and Using Integration Broker Generic Message Feeds.
PSQUERY	Reporting Tools, Query, Query Manager See Creating and Using Query Feeds.
WORKLIST	Worklist, Worklist Worklist, Worklist Details See Creating and Using Worklist Feeds.

Feed Templates

The Feed Publishing Framework provides the ability to create feed templates, which aid in predefining and reusing feed settings and parameters. Feed templates can be created from scratch or an existing feed definition can be saved as a feed template. Feed templates can then be used when creating new feed definitions or when editing existing feed definitions.

Publishing Feeds Using the Feed Publishing Wizard

This section discusses how to use the Feed Publishing Wizard to publish a feed in the following four steps:

Step 1: Specifying Feed Properties.
Step 2: Selecting a Data Source.
Step 3: Specifying Data Source Parameters.
Step 4: Specifying Publishing Options

Pages Used with the Feed Publishing Wizard

Page Name	Definition Name	Navigation	Usage
Feed Publishing Wizard - Specify Feed Properties	PTFP_WIZ_PROP	PeopleTools, Feeds, Feed Publishing Wizard Click the Go to Feed Publishing Wizard link on any Publish Feed Definition page. Click the Feed Properties button from any page in the wizard.	Provide information to identify and categorize a feed definition including optional feed properties. The wizard can also be used to define a feed template. Note. The Template check box on this page can be selected to create a feed template.
Feed Publishing Wizard - Select Data Source	PTFP_WIZ_DATASRC	Click the Next button on the Feed Publishing Wizard - Specify Feed Properties page. Click the Data Type button from any page in the wizard.	Select the feed data type and data source for the feed definition.
Feed Publishing Wizard - Specify Data Source Parameters	PTFP_WIZ_DATAPRMS	Click the Next button on the Feed Publishing Wizard - Select Data Source page. Click the Data Source Parameters button from any page in the wizard.	Specify the data source parameters and their associated options specific to the data type you have selected for the feed definition.
Feed Publishing Wizard - Specify Data Source Parameter Values	PTFP_WIZ_PRMVALS	Click the Values link on the Feed Publishing Wizard - Specify Data Source Parameters page.	Specify prompt values for the end user to select from when personalizing the feed. Note. This page is accessible only for data source parameters for which you have selected the User Specified usage type.
Feed Publishing Wizard - Specify Publishing Options	PTFP_WIZ_PUBOPT	Click the Next button on the Feed Publishing Wizard - Specify Data Source Parameters page. Click the Publish Feed button from any page in the wizard.	Specify the manner in which your feed is published.
Feed Publishing Wizard - Feed Creation Confirmed	PTFP_WIZ_FINISH	Click the Finish button on the Feed Publishing Wizard - Specify Publishing Options page.	Confirm that the creation of the feed definition is complete.

Step 1: Specifying Feed Properties

Access the Feed Publishing Wizard - Specify Feed Properties page (PeopleTools, Feeds, Feed Publishing Wizard; or click the Go to Feed Publishing Wizard link on any Publish Feed Definition page).

Use the Specify Feed Properties page to define feed properties, such as the feed title, as well as advanced feed properties.

Load From Template

The list displays all the available feed templates in the system. Selecting a feed template loads the current feed definition with values from the template.

Template

Select this option to make the current feed definition a feed template.

Important! Unlike the Save As Template link, this option does not create a new object. If you are editing an existing feed definition, the feed definition will be converted into a feed template, which means that the feed itself will no longer be available. Conversely, if you are editing a feed template and deselect this option, the feed template will be converted to a feed definition.

Feed Properties

Feed Title	Enter a short description for this feed at a maximum of 30 characters.
Description	Enter no more than a 254-character description of the feed.
Owner ID	Select the owner ID for the feed definition. The owner ID is a way to identify which definitions are owned by which PeopleSoft applications, such as PeopleSoft General Ledger, Accounts Receivables, PeopleTools, and so on. The values in the drop-down list box are Translate table values associated with the OBJECTOWNERID field. Note. The owner ID does not appear in the published feed document.
Category	Select a category for the feed definition from the list of active categories. If a feed definition is assigned to a category and then that category is deleted, the feed definition no longer displays an assigned category.

Additional Feed Properties

Not all feed readers display all feed properties. This list 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 Creating the Feed Data Type Definition.

Copyright	Enter a copyright date to be included in the feed document.
Logo	Enter a URL to the logo to be included in the feed document, for example: http://myserver.mycompany.com:80/images/logo.gif
Icon	Enter a URL to an icon to be included in the feed document, for example: http://myserver.mycompany.com:80/images/icon.gif
Author Name	Enter the author's name to be included in the feed document.
Author Email	Enter the author's email address to be included in the feed document.
Contributor Name	Enter a contributor's name to be included in the feed document.
Contributor Email	Enter the contributor's email address to be included in the feed document.

Step 2: Selecting a Data Source

Access the Feed Publishing Wizard - Select Data Source page (click the Next button on the Feed Publishing Wizard - Specify Feed Properties page).

Use the Select Data Source page to select the feed data type and then the data source settings for that feed data type.

Data Type	Select the feed data type from the drop-down list of active feed data types.
Data Source	Specify the data source settings. Typically, you will need to select a specific data source; however, depending on the feed data type, there could be zero to three data source settings.

Note. After selecting a data source, you can save the feed definition. However, saving the feed definition is not the same as publishing the feed. You must complete step 4 in the wizard to publish a feed.

Specifying Additional Query Feed Options

If the selected feed data type is PS Query Feeds and you have selected the query data source, then additional grids are displayed for advanced options, query fields, and feed entry content mapping.

See Publishing Query Feeds.

Step 3: Specifying Data Source Parameters

Access the Feed Publishing Wizard - Select Data Source Parameters page (click the Next button on the Feed Publishing Wizard - Select Data Source page).

Use the Select Data Source Parameters page to configure each data source parameter, such as the parameter's description, usage type, and default value. Each data source parameter can have one value only. Required parameters must have a default value assigned.

Note. This page is accessible only when you are building a feed definition with a data source that allows modification of one or more data source parameters.

Field Name

Displays the name of the data source parameter.

Description

Displays a description of the data source parameter.

Usage Type

The usage type defines how the parameter gets a value at runtime:

Admin Specified: Select to allow administrative users to specify values to configure the feed definition for their user community or communities. The value of an administrator-specified parameter can be derived as follows: as a system default value, as an administrator-configured value, or as a pure runtime value. The following list describes each method for deriving the value of an administrator-specified parameter listed in their order of precedence when the feed is requested:
1. Runtime value: Runtime values are values passed in using query parameters of the feed request. Runtime values are not stored.
2. Administrator-configured value: Administrator-configured values can be specified by configuring the feed through the My Feeds page. Administrator-configured values are stored as feed personalization data.
3. System default values: System default values can be specified on this page at design time, and are stored with the feed definition.
4. Empty values: Provides the correct empty value according to the parameter's data type. For example if the parameter is a number, then 0 would be provided; for a string, "" would be provided.
Fixed: Select to enter a fixed value for the data source parameter. This value is stored with the feed definition.
System Variable: Select to assign a system variable as the data source parameter value. The actual value of the parameter is determined at runtime.

For example, suppose that you specify %DateTime as the system variable for a parameter named Timestamp. When the feed is requested, the Timestamp parameter is populated by the current value of %DateTime.
User Specified: Select to allow end users to specify values to personalize the feed definition for their own use. The value of an user-specified parameter can be derived as follows: as a system default value, as a user-configured value, or as a pure runtime value.

Note. User personalization does not apply to feeds published as public and a warning message is issued when the feed definition is saved.

The following list describes each method for deriving the value of a user-specified parameter listed in their order of precedence when the feed is requested:
1. Runtime value: Runtime values are values passed in using query parameters of the feed request. Runtime values are not stored.
2. User-configured value: User-configured values can be specified by personalizing the feed through the My Feeds page. User-configured values are stored as feed personalization data.
  
  Users can select a value from a prompt, or they can manually enter their own value if no prompt values are available. To define the list of valid prompt values, click the Values link. This list of prompt values and the default value are stored with the feed definition.
  
  See Specifying Prompt Values for Data Source Parameters.
3. System default values: System default values can be specified on this page at design time, and are stored with the feed definition.
4. Empty values: Provides the correct empty value according to the parameter's data type. For example if the parameter is a number, then 0 would be provided; for a string, "" would be provided.

Required

A data source parameter is defined as required in the application class for the feed data type. This check box is selected but disabled except for user-specified parameters. All required parameters should be assigned a default value before proceeding to step 4 in the wizard.

Default Value

Enter the default value for the data source parameter. The data type of the value you enter should be the same as the parameter’s data type. However, the entered value is not type checked by the Feed Publishing Wizard; the type should be checked by and any errors reported by the application class for the feed data type.

Consider these guidelines when entering a default value:

If you select User Specified as the usage type and the data source parameter is a required value, you must enter the default value that will appear before a user enters a value. If the data source parameter is not a required value, you do not have to enter a default value.

If you select a default value when defining prompt values on the Feed Publishing Wizard - Specify Data Source Parameter Values page, that default value populates this field.

If you select User Specified as the usage type, you can also enter a system variable as the default value. For example, to make the current date the default value for a user-specified date parameter, enter a default value of %Date.

If you select System Variable as the usage type, you must enter a supported system variable to use as the data source parameter value. You can use the Look up Value button to access the following list of supported system variables:

%AuthenticationToken	%ClientDate
%ClientTimeZone	%ContentID
%ContentType	%Copyright
%Currency	%Date
%DateTime	%DbName
%DbServerName	%DbType
%EmailAddress	%EmployeeId
%HPTabName	%IsMultiLanguageEnabled
%Language^*	%Language_Base
%MaxInterlinkSize	%LocalNode
%Market	%MaxMessageSize
%NavigatorHomePermissionList	%Node^*
%PasswordExpired	%Portal^*
%PrimaryPermissionList	%ProcessProfilePermissionList
%RowSecurityPermissionList	%RunningInPortal
%ServerTimeZone	%Time
%UserDescription	%UserId

^* The language code, portal name, and node name passed in through the query parameters of the request are used as the values for %Language, %Portal, and %Node respectively. If the request does not contain these parameters, then the corresponding system variable’s value will be used.

If you select Fixed as the usage type, you must enter the fixed value if this is a required parameter.

Values

Note. The Values link is displayed for parameters with an associated translate table, Yes/No type of parameters, or if you select User Specified as the usage type.

Click Values link to access the Feed Publishing Wizard - Specify Data Source Parameter Values page.

See Specifying Prompt Values for Data Source Parameters.

Text

Note. If you select User Specified as the usage type, the Personalization Instructions group box is displayed.

Use the Text field to enter custom personalization instructions for the feed. These personalization instructions appear on the personalization page of the feed.

Note. Personalization instructions must be translatable.

Specifying Prompt Values for Data Source Parameters

Access the Feed Publishing Wizard - Specify Data Source Parameter Values page (click a Values link on the Feed Publishing Wizard - Select Data Source Parameters page).

Use the Specify Data Source Parameter Values page to specify the prompt values that are displayed to users when they personalize the feed.

For Yes/No type of parameters and for parameters associated with a translate table, you cannot modify or add to the values listed on this page. However, for user-specified parameters, you can add, edit, or delete value-description pairs. In addition, you can specify the default value for the data source parameter.

Parameter Value

Specify the parameter value.

Description

Provide an optional description of the parameter value.

Default

Select one value as the default value. If the parameter is required, then a default value is required; otherwise, it is optional.

Step 4: Specifying Publishing Options

Access the Feed Publishing Wizard - Specify Publishing Options page (click the Next button on the Feed Publishing Wizard - Select Data Source Parameters page).

Use the Specify Publishing Options page to specify the publishing options for a feed definition.

A feed definition can be published to multiple sites, or to no site at all. Publishing a feed definition to a site makes that feed available to all users of that site. Once published, a feed can be removed from a site by deselecting the publish option. Users will no longer be able to access and view an unpublished feed; however, the feed definition for an unpublished feed can still be edited using the Feed Publishing Wizard.

Feed Security Options

For query feeds and worklist feeds, the Feed Security Options group box is hidden. For worklist feeds, real-time security is always used. For query feeds, security can be set in Step 2 of the Feed Publishing Wizard.

Publish as Public

Select to make the feed available for public access.

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.

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.

Feed Publishing Options

If the Template option was selected in Step 1, the Feed Publishing Options group box is hidden.

Publish feed to current site

Select this option to publish the feed to the current site. Deselect this option to remove the published feed from the current site.

Publish Feed to Other Sites

Click to save the feed definition and publish it to additional sites.

See Publishing Feed Definitions to Additional Sites.

Feed Authorization Override

By default, the authenticated user who requests a feed is used for generating the feed. You can override the default behavior by specifying a user ID and password to be used for requests for this feed. Doing so ensures every user who requests the feed sees the same result. This can be useful for public feeds.

Warning! Use care when selecting a user ID for this override as this can potentially give unauthorized users access to feed data that they would not normally be able to see.

User ID	Specify the user ID to use as the override for requests for this feed.
Password	Specify the password for this user.
Use this user for all requests	Select this option to use the specified user ID and password as the authentication override. If this option is not selected, then the user ID and password data is merely saved, but not used.

Actions

Finish	Click the Finish button to publish the feed definition. Note. The Finish button appears for new feed definitions only. Use the Save button for already published feed definitions.
Save	Click the Save button to publish the feed definition. Note. The Save button appears for already published feed definitions only. Use the Finish button for new feed definitions.
Preview Feed	Click to preview the published feed. Note. This link appears for already published feed definitions only.
Save As Template	Click to save the existing feed definition as a feed template. After a feed definition is saved as a feed template, both will exist as separate entities. The original feed definition can be used normally as any other feed and the feed template can be used while creating new feeds or editing existing feed definitions. The feed template will be saved with the same security as that of the feed definition. Note. This link appears for already published feed definitions only.

Publishing Feeds Using the Publish as Feed Pages

This section discusses how to:

Define feed properties.
Define advanced feed options.
Manage published feeds.

Pages Used with the Publish as Feed Links

Page Name	Definition Name	Navigation	Usage
Publish Feed Definition	PTFP_PUB_AS_FEED	Click the Publish as Feed link on the administration page for the item to be published as a feed. Click the Edit button on the Publish as Feed page. Click the Add Feed button on the Publish as Feed 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 on the Publish Feed Definition page.	Enter advanced option values that are specific to the feed data type.
Publish as Feed	PTFP_PUB_AS_LIST	If one or more feeds have been defined for this item, click the Publish as Feed link on the administration page for the item. Click the Publish button on the Publish Feed Definition page. Click the Cancel button on the Publish Feed Definition page.	Review, edit, add, or delete feed definitions for this item.

Defining Feed Properties

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

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

Load From Template

Feed templates that match the given data type and data source settings are available in the drop-down list. Selecting a feed template from the drop-down populates the existing feed definition with the values from the feed template.

Feed Properties

Feed Title	This field is prepopulated 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 254-character description of the feed.
Owner ID	Select the owner ID for the feed definition. The owner ID is a way to identify which definitions are owned by which PeopleSoft applications, such as PeopleSoft General Ledger, Accounts Receivables, and so on. The values in the drop-down list box are Translate table values associated with the OBJECTOWNERID field. Note. The owner ID does not appear in the published feed document.
Category	Select a category for the feed definition from the list of active categories.Select a category for the feed definition from the list of active categories. If a feed definition is assigned to a category and then that category is deleted, the feed definition no longer displays an assigned category.
Advanced Options	Click the Advanced Options link to access the Advanced Options page for the feed data type. Advanced options vary by feed data type.

Additional Feed Properties

Not all feed readers display all feed properties. This list 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 Creating the Feed Data Type Definition.

Copyright	Enter a copyright date to be included in the feed document.
Logo	Enter a URL to the logo to be included in the feed document, for example: http://myserver.mycompany.com:80/images/logo.gif
Icon	Enter a URL to an icon to be included in the feed document, for example: http://myserver.mycompany.com:80/images/icon.gif
Author Name	Enter the author's name to be included in the feed document.
Author Email	Enter the author's email address to be included in the feed document.
Contributor Name	Enter a contributor's name to be included in the feed document.
Contributor Email	Enter the contributor's email address to be included in the feed document.

Feed Security Options

The list that follows describes feed security options.

Note. Query feeds apply security on 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 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 already published feed definitions only when you select the Publish with Selected Security option.
Type	Select either Role or Permission List security.
Name	Enter the name of the permission list or role that has access to the feed.

Actions

Publish	Click the Publish button to publish the feed definition.
Preview Feed	Click to preview the published feed. Note. This link only appears for already published feed definitions.
Publish Feed to Other Sites	Click to publish the already published feed definition to additional sites. Note. This link only appears for already published feed definitions. See Publishing Feed Definitions to Additional Sites.
Save As Template	Click to save the existing feed definition as a feed template. After a feed definition is saved as a feed template, both will exist as separate entities. The original feed definition can be used normally as any other feed and the feed template can be used while creating new feeds or editing existing feed definitions. The feed template will be saved with the same security as that of the feed definition.
Go to Feed Publishing Wizard	Click to save any changes and open the feed definition in the Feed Publishing Wizard

Defining Advanced Feed Options

Access the Advanced Feed Options page (click the Advanced Options link on the Publish Feed Definition page).

Advanced options differ by feed data type.

Max Number of Entries

Enter the maximum number of entries that the feed should return to the user. Enter 0 for unlimited entries up to the maximum row limit specified on the Feed Options page, which is 300 by default.

Note. You can configure the upper limit on the Feed Options page. If the maximum number of entries specified is either 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 PTFP_MAX_ROW_LIMIT is 0 or is undefined, then the output is limited by the maximum number of entries.

Reset to Defaults

Click to reset any advanced options to their default values.

Managing Published Feeds

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

Use the Publish as Feed page to review, edit, add, or delete feed definitions for this item.

Feed Title	Click a link to open the feed document for this feed definition in a separate browser window.
Edit	Click this button to access the Publish Feed Definition page on which you can edit the published feed definition.
Delete	Click this button to delete the feed definition.
Return	Click this button to return to the administration page for the item.
Add Feed	Click this button to define and publish a new feed definition for the item.

Creating and Editing Feed Templates

You can create and edit feed templates much in the same way that you create and edit feed definitions:

At Step 1 (Feed Publishing Wizard - Specify Feed Properties page), you can select the Template option:
- For a new definition, the object will be saved as a feed template.
- For an existing feed definition, the object will be converted to a feed template, which means that the feed itself will no longer be available.
See Step 1: Specifying Feed Properties.
At Step 4 (Feed Publishing Wizard - Specify Publishing Options page), you can click the Save As Template link to save an existing feed definition as a feed template.

After a feed definition is saved as a feed template, both will exist as separate entities.

See Step 4: Specifying Publishing Options.
On the Publish Feed Definition page, you can click the Save As Template link to save an existing feed definition as a feed template.

After a feed definition is saved as a feed template, both will exist as separate entities.

See Defining Feed Properties.

Publishing a List of Feeds Feed

A list of feeds feed is a feed that contains a list of all available feeds of a specific feed data type. When you access a list of feeds feed, you see a listing of only the feeds that you are authorized to view. You can publish a list of feeds feed through the Feed Publishing Wizard or from the Feed Data Types page.

You publish a list of feeds feed by using the FEED data type.

To publish a list of feeds feed using the Feed Publishing Wizard:

Select PeopleTools, Feeds, Feed Publishing Wizard.
Select to add a new value.
Enter a feed ID and click Add.
At Step 1, enter a feed title at a minimum.

Note. To distinguish this as a list of feeds, you can change the feed title to include “List of”—for example, “List of Query Feeds”.

See Step 1: Specifying Feed Properties.
Click Next.
At step 2, select List of Feeds as the data type.
Select the data source for which to produce the list of feeds:
- FEED
  
  Select this option to produce a list of all published list of feeds feeds.
- GENERICFEED
  
  Select this option to produce a list of all published generic Integration Broker message feeds.
- PSQUERY
  
  Select this option to produce a list of all published query feeds.
- WORKLIST
  
  Select this option to produce a list of all published worklist feeds.
See Step 2: Selecting a Data Source.
Click Next.
Click Next to accept the defaults for the data source parameters.

Otherwise, modify the data source parameters to suit your implementation.

See Step 3: Specifying Data Source Parameters.
At Step 4, specify the feed publishing options.

See Step 4: Specifying Publishing Options.
Click Finish to publish the feed definition.

Publishing Feed Definitions to Additional Sites

A feed definition can be published to additional sites from the Feed Publishing Wizard or from the Publish as Feed pages.

Pages Used to Publish Feed Definitions to Additional Sites

Page Name	Definition Name	Navigation	Usage
Publish Feed Definition to Sites	PTFP_PUB_AS_SITES	Click the Publish Feed to Other Sites link at Step 4 of the Feed Publishing Wizard. Click the Publish Feed to Other Sites link on the Publish Feed Definition page.	Select additional sites to which to publish an existing feed definition.

Publishing Feed Definitions to Additional Sites

Access the Publish Feed Definition to Sites page (click the Publish Feed to Other Sites link at Step 4 of the Feed Publishing Wizard or on the Publish Feed Definition page).

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

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 definition. This field is display-only.
Select All	Click to select all feed definitions in the list.
Clear All	Click to deselect all feed definitions.
Publish Feed	Click to publish the feed definition to additional sites.

Accessing Feeds

This section discusses how to:

Use the My Feeds page.
Use related feeds hover menus.
Use the GetFeedList service operation.

Pages Used to Access Feeds

Page Name	Definition Name	Navigation	Usage
My Feeds	PTFP_VIEW	My Feeds	Search for and view the list of published feeds to which you have access.
Personalize <Feed Title>	PTFP_USER_PERS	Click a Personalize link on the My Feeds page.	Personalize the feed with user-specified values.
Configure <Feed Title>	PTFP_ADMIN_PERS	Click a Configure link on the My Feeds page.	Configure the feed as a feed administrator for this site.

Using the My Feeds Page

Access the My Feeds page (click My Feeds in the Main Menu).

Use the My Feeds page to search for and view the list of published feeds to which you have access.

Search Feed Definitions

Data Type	Select from the following feed data types: All Data Types returns a list of all feeds to which you have access. Note. This value is the default. IB Generic Message Feeds returns a list of Integration Broker generic message feeds. List of Feeds returns a list of all feed list feeds. PS Query Feeds returns a list of PeopleSoft Query feeds. Worklist Feeds returns a list of worklist feeds. Note. The previous list includes only the base feed data types delivered with PeopleTools. The results can differ on your system depending which other PeopleSoft applications you have installed and whether any custom feed data types have been developed.
Feed Type	Select from the following feed types: Real Time returns a list of real-time feeds. Scheduled returns a list of scheduled feeds.
Category	Select from the feed categories defined on your system.
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 options to search for feeds: Current Site Select this option to search in the current site only. Note. 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 entered.
Reset	Click the Reset button to clear the search results and reset all search criteria to their default values.
Export Feed List	Click this link to export the current search results in the Feed Definitions grid to a file in OPML 2.0 format. You can import OPML files into third-party feed readers, and you will be able to subscribe to each feed in 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 you have permission to access.

Feed Title	Click the link for a feed title to view the feed document in a separate browser window.
Site Name	Displays the site to which the feed has been published. Note. The Site Name column appears when the All Sites option is selected.
Configure	Click a Configure link to configure the feed as an administrator for this site. Note. The Configure link appears only for those feeds that have been defined in the Feed Publishing Wizard with Admin Specified data source parameters. See Step 3: Specifying Data Source Parameters.
Personalize	Click a Personalize link to personalize the feed by specifying user personalization values. Note. The Personalize link appears only for those feeds that have been defined in the Feed Publishing Wizard with User Specified data source parameters. See Step 3: Specifying Data Source Parameters.

Personalizing a Feed

Access the Personalize feed page (click a Personalize link on the My Feeds page).

Use the Personalize feed page to set user personalization values for the feed. Only data source parameters defined as User Specified in the feed definition will appear on this page.

Reset to Defaults

Click the Reset to Defaults button to reset all parameter values to their system default values stored with the feed definition.

Configuring a Feed

Access the Configure feed page (click a Configure link on the My Feeds page).

Use the Configure feed page to set administrator-specified values for the feed. Only data source parameters defined as Admin Specified in the feed definition will appear on this page.

Reset to Defaults

Click the Reset to Defaults button to reset all parameter values to their system default values stored with the feed definition.

Using 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 have been published for that particular feed data type. To hide inactive hover menus, set a value on the Feed Options page.

Using the GetFeedList 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 their 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 GetFeedList operation provides the capability to query feeds through the use of operational query parameters, the same way as the My Feeds component. This table provides Some examples of the parameters:

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 a 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 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. PeopleTools provides one GetFeedList service. However, you can 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:⇒
//xxxxx.xx.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:⇒
//xxxxx.xx.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://xxxxx.xx.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:⇒
//xxxxx.xx.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://xxxxx.xx.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://xxxxx.xx.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:⇒
//xxxxx.xx.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://xxxxx.xx.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:⇒
//xxxxx.xx.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:⇒
//xxxxx.xx.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:⇒
//xxxxx.xx.oracle.com:8920/PSIGW/HttpListeningConnector/feeds/GetRealTimeFeed?⇒
FEED_ID=ADMN_WORKLIST_ITEMS&amp;PORTAL_NAME=EMPLOYEE&amp;NODE_NAME=QE_LOCAL"/>
  </body>
</opml>

Viewing Feeds

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

To view feeds:

Click the feed link.

The feed will open in the browser.
Alternatively, paste the URL into a feed reader.

This is an example of a feed in the browser: