Administering the Feed Publishing Framework
This chapter discusses how to:
Administer the Feed Publishing Framework.
Migrate feeds between databases.
Use SysAudit information.
Archive feeds.
Administering the Feed Publishing Framework
This section discusses how to:
Set Feed Publishing Framework options.
Define feed categories.
Copy feed definitions.
Delete feed definitions.
Pages Used to Administer the
Feed Publishing Framework|
Page Name |
Definition Name |
Navigation |
Usage |
|
Feed Options |
PTFP_OPTIONS |
PeopleTools, Feeds, Feed Options |
Define system-wide options for the Feed Publishing Framework. |
|
Define Feed Categories |
PTFP_CATEGORIES |
PeopleTools, Feeds, Define Feed Categories |
Manage the categories used to organize feeds. |
|
Copy Feed Definitions |
PTFP_SAVEAS |
PeopleTools, Feeds, Copy Feed Definitions |
Clone an existing feed definition to one with a new feed ID. |
|
Delete Feed Definitions |
PTFP_DELETE |
PeopleTools, Feeds, Delete Feed Definitions |
Delete the selected feed definitions from all sites. |
|
Define Feed Categories - Delete Confirmation |
PTFP_CONFIRM_DEL |
Click the Delete Category button on the Define Feed Categories page. |
Confirm the deletion of a feed category. |
|
Delete selected feeds? - Delete Confirmation |
PTFP_CONFIRM_DEL |
Click the Delete Selected Feeds button on the Delete Feed Definitions page. |
Confirm the deletion of a feed definition. |
|
Copy Feed Definitions - Copy confirmed |
PTFP_CONFIRM_SAVE |
Click the Save Selected Feed button on the Copy Feed Definitions page. |
Confirm the copy of a feed definition. |
Setting Feed Publishing Framework Options
Access the Feed Options page (PeopleTools, Feeds, Feed Options).
Use the Feed Options page to define system-wide options for the Feed Publishing Framework.
|
Log client request |
Select Yes to enable logging of feed requests in the PTFP_ACCESS_LOG table. The default value is No. |
|
Last Log ID |
Displays the log ID of the last feed request. |
|
Max Rows Limit |
Specify the limit for the maximum number of feed entries in a feed. This limit applies to all feed types except paged scheduled feeds. |
|
Show Inactive Feed Menu |
Select No to hide the related feeds hover menu when it is inactive—that is, when no feeds of that type have been defined. The default value is Yes, show the related feeds hover menu when it is inactive. |
Defining Feed Categories
Access the Define Feed Categories page (PeopleTools, Feeds, Define Feed Categories).
Use the Define Feed Categories page to manage categories used to organize feeds.
|
Category ID |
Specify a unique ID for the feed category. Note. The category ID is a user-specified, not system-defined, value. |
|
Description |
Enter a short description for the feed category. This description appears wherever a category can be assigned to a feed definition and in locations where you can search for feeds. |
|
Active |
Indicate whether the feed category is active or inactive. An inactive category is not available to assign to feed definitions or in locations where you can search for feeds. However, if a feed definition is assigned to a category and then that category is made inactive, the feed definition no longer displays an assigned category. |
|
Long Description |
Enter a long description for the feed category. |
|
Delete Category |
Click to delete the feed category. If a feed definition is assigned to a category and then that category is deleted, the feed definition no longer displays an assigned category. |
Copying Feed Definitions
Access the Define Feed Categories page (PeopleTools, Feeds, Copy Feed Definitions).
Use the Copy Feed Definitions page to clone an existing feed definition to one with a new feed ID. The new feed definition is published with the same feed options and to the same sites as the original.
|
Data Type |
Select from the following feed data types:
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:
|
|
Site Name |
Select from the sites available on your system. This field does not filter the search results; the results indicate whether a feed definition is published to the selected site. |
|
Category |
Select from the active 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 |
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. |
|
Feed Definitions |
Select the feed from this grid that you wish to copy. Note. The Published field indicates that the feed definition is published to the site selected in the Site Name field. |
|
New Feed ID |
Enter an ID for the new feed definition using only alphabetic characters (A–Z), numeric characters (0–9), and the underscore character (_). Note. The system converts all lowercase characters to uppercase. In addition, it will convert any other special characters, such as a space, #, @, and so on, to an underscore. |
|
Save Selected Feed |
Click to copy the selected feed definition to a new feed definition. |
Deleting Feed Definitions
Access the Delete Feed Definitions page (PeopleTools, Feeds, Delete Feed Definitions).
Use the Delete Feed Definitions page to delete selected feed definitions. The system deletes the feed definition from all sites to which it has been published.
|
Data Type |
Select from the following feed data types:
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:
|
|
Site Name |
Select from the sites available on your system. This field does not filter the search results; the results indicate whether a feed definition is published to the selected site. |
|
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 |
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. |
|
Feed Definitions |
Select the feed definition or definitions from this grid that you want to delete. Note. The Published field indicates that the feed definition is published to the site selected in the Site Name field. |
|
|
Click to select all feed definitions in the list. |
|
|
Click to clear the selection of any feed definitions. |
|
Delete Selected Feeds |
Click to delete the selected feed definition or definitions. |
Migrating Feeds Between Databases
Use PeopleSoft Data Mover to migrate feeds between databases.
See Using PeopleSoft Data Mover.
This section discusses how to migrate between databases.
To move existing seed data:
To export existing feed seed data from the source database, in the source database open Data Mover and then modify and run the ptfp_setup_exp.dms script.
To import existing feed seed data into the target database, in the target database open Data Mover and then modify and run the ptfp_setup_imp.dms script.
To export feed definitions, use the script that is provided as message catalog entry: message set 219, message 3300 (without user personalization) or message 3302 (with user personalization). To export feed definitions, perform the following tasks:
Select PeopleTools, Utilities, Administration, Message Catalog.
Enter 219 in the Message Set Number field and press the Enter key.
Click the Find link and enter 3300 in the Enter Search String field.
The system will retrieve the script for exporting feed definitions without user personalization. Enter 3302 to export with user personalization.
Click the OK button.
Copy the script from the Description field.
Open Data Mover in the source database.
Paste the script into the upper pane, modify the script as necessary, and run the script.
To import feed definitions, use the script that is provided as message catalog entry: message set 219, message 3301 (if you have exported the feed definition without user personalization) or 3303 (if you have exported the feed definition with user personalization). To import feed definitions, perform the following tasks:
Select PeopleTools, Utilities, Administration, Message Catalog.
Enter 219 in the Message Set Number field and press the Enter key.
Click the Find link and enter 3301 in the Enter Search String field.
The system will retrieve the script for importing feed definitions without user personalization. Enter 3303 to import with user personalization.
Click the OK button.
Copy the script from the Description field.
Open Data Mover in the target database.
Paste the script into the upper pane, modify the script as necessary, and run the script.
Note. The import script deletes any feeds with the same feed ID in the target database before importing the feed definitions.
See Also
Using SysAudit Information
SysAudit information is available for:
Feed definition integrity.
PS Query feed integrity.
Worklist feed integrity.
See Also
Archiving Feeds
This section provides an overview of archiving feed data and discusses how to archive scheduled feed data.
Understanding the Archiving of Feed DataScheduled feeds are published asynchronously and stored as messages in Integration Broker queues. The process of archiving feed data archives the messages stored in the Integration Broker queues used by scheduled feeds. You run a batch process to archive and delete the queue message data.
This section provides an overview of:
Feed archiving parameters.
Feed archiving options and logic.
The following parameters specified in the feed definition are used for archiving the Integration Broker queue messages:
Integration Broker Service Operation name
For generic scheduled feeds, the service operation name is the value of the IB_OPERATIONNAME data source setting.
For other scheduled feeds, the system uses the service operations listed in the Feed Service Operations grid on the Define Data Types page.
Integration Broker subqueue name, when applicable
For generic scheduled feeds, no subqueue name exists.
For other scheduled feeds, the Feed ID value is the sub queue name.
PTFP_FEED:UTILITY:Utility DSPARAMETER_MAXROW
For scheduled feeds, you must define this parameter in the data source parameter for the data type.
This parameter indicates the number of feed items that will appear to the user.
If the parameter value is PTFP_FEED:UTILITY:Utility SF_MAXROWOPTION_LATESTMSG, then only the latest message in the Integration Broker queue appears to the user.
If the parameter value is PTFP_FEED:UTILITY:Utility SF_MAXROWOPTION_ALLMSGS, then all the messages in the Integration Broker queue appear to the user.
The parameter can be a number, for example, 4, which indicates that only 4 items appear to the user.
PTFP_FEED:UTILITY:Utility DSPARAMETER_SF_MAXMINUTES
For scheduled feeds, you must define this parameter in the data source parameter for the data type.
This parameter tells the length of time for which the feed messages are valid in the Integration Broker queues.
If the parameter value is PTFP_FEED:UTILITY:Utility SF_MAXMINUTES_ALLMSGS, then all the messages appear to the user.
If the parameter value is a number, for example 100, then all the feed messages existing in the Integration Broker queue for fewer than 100 minutes appear to the user.
Feed Archiving Options and Logic
This table describes the feeds archiving options and logic:
|
Option Value |
Description |
Archiving Logic |
|
0 |
Archive all messages that are not within the specified date and time range. |
When DSPARAMETER_SF_MAXMINUTES is not SF_MAXMINUTES_ALLMSGS. |
|
1 |
Archive all messages except latest 1 message per subqueue per language. |
When DSPARAMETER_SF_MAXMINUTES is SF_MAXMINUTES_ALLMSGS and DSPARAMETER_MAXROW is SF_MAXROWOPTION_LATESTMSG. |
|
2 |
Archive all messages except latest n messages per subqueue per language. |
When DSPARAMETER_SF_MAXMINUTES is SF_MAXMINUTES_ALLMSGS and DSPARAMETER_MAXROW is some number. This number indicates the number of messages that should not be archived. |
|
3 |
Archive nothing. |
When DSPARAMETER_SF_MAXMINUTES is SF_MAXMINUTES_ALLMSGS and DSPARAMETER_MAXROW is SF_MAXROWOPTION_ALLMSGS. |
Note. The feed archiving options are implicitly arrived at based on the feed definition. These cannot be specified when the PTIBFEEDARCH process runs.
Page Used to Archive Feeds|
Page Name |
Definition Name |
Navigation |
Usage |
|
Run Feed Archive |
IB_FEEDARCHIVE |
PeopleTools, Feeds, Archive Feed Data |
Archive the messages stored in the Integration Broker queues used by scheduled feeds. Run a batch process to archive and delete the queue message data. |
Archiving Scheduled Feed Data
Access the Run Feed Archive page (PeopleTools, Feeds, Archive Feed Data).
Click the Run button to access the PTIBFEEDARCH process:
Use the Run Feed Archive page to archive Integration Broker messages that are used by scheduled feeds. Archiving takes no parameters from the user; parameters for archiving come from the feed definitions themselves.
All scheduled feeds are archived simultaneously; you cannot selectively archive feeds. The process archives and deletes the feed data based on the Archive flag in the Integration Broker queue used in the service operations that published messages to Integration Broker queues. If the Archive flag is enabled, then the messages are archived and then deleted; otherwise, the messages are just deleted.
You can view archived Integration Broker messages by using the Service Operations Monitor. Look for asynchronous services with the Archive flag enabled.
Note. A scheduled feed can be archived only if the service operations involved in the scheduled feeds are listed in the Feed Service Operations grid on the Define Feed Data Types page.
Note. Feeds archiving logic is comparable to Integration Broker archiving logic. For a feed message to be archived, you must select the Archive check box on the Queue Definition page for the service operation. If you do not select the Archive check box, then the feeds archiving process deletes the feed messages and the messages do not appear on the Service Operation Monitor - Asynchronous Services page when the Archive check box is selected.
See Monitoring Asynchronous Service Operation Transactions.
Select All
Clear All