Creating and Using Worklist Feeds

This chapter provides an overview of worklist feeds and discusses how to:

Click to jump to parent topicUnderstanding Worklist Feeds

Worklist feeds provide the ability to publish a user's worklist as a feed in real time. By using worklist feeds, the worklist items can be available from systems other than the system that originated the entries without copying the data. Worklist feeds use the Feed Publishing Framework for delivering feeds. PeopleTools delivers the WORKLIST feed data type to publish worklist feeds.

Worklist feeds are real-time feeds. The feed is generated in the security context of the signed on user and it reflects the user’s current worklist items. It does not show worked items.

Worklist Feed Additional Configuration

In addition to all configuration steps for other feeds, worklist feeds require an additional step.

The node that contains the Worklist and Worklist Details pages should have Content URI Text and Portal URI Text defined. This text will be used for generating the worklist item URLs. To find the node name, navigate to the Worklist and Worklist Details pages and look at the URL. It will be as follows:

http://machine:port/psp/ps/EMPLOYEE/PT_LOCAL/w/WORKLIST?ICAction=ICViewWorklist&Menu=Worklist&Market=GBL&PanelGroupName=WORKLIST.

In the previous URL, PT_LOCAL is the node, therefore, you should define the Content URI Text and the Portal URI Text for the PT_LOCAL node so that worklist feeds point to the correct worklist items.

WORKLIST Feed Data Type

PeopleSoft Feed Publishing Framework delivers the WORKLIST feed data type for worklist feeds.

To access the Define Feed Data Types page, select PeopleTools, Feeds, Define Feed Data Types (PTFP_DATATYPE).

The only values that should be changed for the WORKLIST data type are the Default Feed Properties.

Not all readers display all properties. The default feed properties that some feed readers process and display are described below.

Note. These default properties are for all worklist feeds. You may change any of these default properties at the individual feed level.

Copyright

Enter copyright information 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.

Click to jump to parent topicPublishing Worklist Feeds

This section provides an overview of the steps used to publish a worklist feed and discusses how to:

Click to jump to top of pageClick to jump to parent topicUnderstanding the Steps to Publish a Worklist Feed

Any user with the role PeopleSoft Administrator will be able to publish worklist feeds from either the Worklist or Worklist Details pages.

Access the Worklist page (select Worklist, Worklist).

To publish a Worklist Feed:

  1. Click the Publish as Feed link.

  2. Enter a Feed Title and description.

  3. Enter any overrides necessary for Additional Feed Properties and Contributors.

  4. Click the Advanced Options link.

  5. Enter the worklist parameters and values for the feed.

  6. Click OK.

  7. Click Publish.

Click to jump to top of pageClick to jump to parent topicDefining Worklist Feeds

Access the Publish Feed Definition (PTFP_PUB_AS_FEED) page from either the Worklist or Worklist Details pages by clicking the Publish as Feed link.

In Additional Feed Properties, enter feed properties that will override the properties set on the Data Feed Type page. You can also add contributors.

Feed Properties

Feed Title

This field is prepopulated with Worklist Items. Change the title to a name that will help you identify the specific worklist.

Note. Multiple worklists can be entered for one title; however, since the worklist parameters entered on the Advanced Options page use AND logic, you may not get the desired results.

Description

Enter a description of the feed. No more than 255 characters are allowed.

Advanced Options

Click the Advanced Options link to access the Worklist Advanced Feed Options page.

Publish

Click the Publish button to publish the feed.

Preview Feed

Use this link to preview the feed after defining the Advanced Options.

Note. The system will display worklist items only if they exist for the signed on user.

Publish Feed to Other Sites

Select this link to publish the worklist to other PeopleSoft sites.

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

Access the Worklist Advanced Feed Options (WL_PUB_AS_ADVOPT) page (click the Advanced Options link on the Worklist Publish as Feed page).

Use this page to determine which worklists are published as feeds.

Max Number of Entries (maximum number of entries)

Enter the maximum number of feed entries to display in the feed reader.

Worklist Feed Parameters

Select the parameters and values for the worklists that you want to publish. A status of 1 or 0 will always be included. Worklist feeds will only show worklist items that are either Available or Selected. After a worklist item is Worked, it will no longer appear in the feed.

Note. Even if rows for statuses 0 and 1 are deleted from the grid, worklist feeds will always show all available and selected worklist items.

When multiple feed parameters are specified, similar parameters use OR, while distinct parameters use AND in the WHERE clause generated by the SQL fetch.

Worklist Feed Parameters

This table lists worklist feed parameters and their values and data source property:

Parameter Name

Values

Data Source Property

Activity Name

Select from any workflow activity.

ACTIVITYNAME

Business Process Name

Select from any business process.

BUSPROCNAME

Event Name

Select from any event.

EVENTNAME

From

Select from any user.

ORIGINATORID

Priority

1-High, 2-Medium, or 3-Low

WL_PRIORITY

Status

0-Available or 1-Selected

INSTSTATUS

Timed Out

0-Available or 1-Timed Out

TIMEDOUT

Worklist Name

Select from any worklist.

WORKLISTNAME

Note. The Priority field denotes the priority that the user, that is the receiver of the notification, has assigned to the worklist item in the Worklist page and not the priority with which the worklist item was created.

When you specify multiple feed parameters, similar parameters use OR, while distinct parameters use AND in the WHERE clause. For example, if the parameters were defined as shown in this table:

Parameter

Value

Business Process Name

Administer Workflow

Activity Name

Send Note

Event Name

Worklist Note

Worklist Name

Worklist Note

Priority

1

Status

1

Status

0

Timed Out

0

From

PSADMIN

From

PTSECADM

Then the WHERE clause for the SQL statement generated for parameters shown in the preceding table is: WHERE (BUSPROCNAME=’Administer Workflow’) AND (ACTIVITYNAME =’Send Note’) AND (EVENTNAME=’Worklist Note’) AND (WORKLISTNAME=’Worklist Note’) AND (WL_PRIORITY=’1’) AND ((INSTSTATUS=0) OR (INSTSTATUS=1)) AND (TIMEDOUT=0) AND((ORIGINATORID=’PSADMIN’) OR (ORIGINATORID=’PTSECADM’))

This table describes how the system maps the feed properties to Atom 1.0 data source values:

Feed Property

Maps To

Author

ORIGINATORID and primary email address

Category

BUSPROCNAME, ACTIVITYNAME, EVENTNAME, WORKLISTNAME, WL_PRIORITY, TIMEDOUT, INSTSTATUS, ORIGINATORID

ContentURL

Worklist entry URL

Copyright

none

Contributor

none

Description

BUSPROCNAME | "/" | ACTIVTYNAME | "/" | EVENTNAME

Created On: INSTAVAILABLEDTTM

Instance ID: INSTANCEID From: ORIGINATORID

Enclosure

none

FullContent

none

GUID

Worklist URL | “ “ | INSTAVAILABLEDTTM

Published

INSTAVAILABLEDTTM

Title

INSTANCEID | "." | BUSPROCNAME | "/" | ACTIVTYNAME | "/" | EVENTNAME

Updated

LASTUPDDTTM

Note. INSTAVAILABLEDTTM is the time at which the worklist item was created.

LASTUPDDTTM is the time at which the worklist item was last updated or selected.

Click to jump to parent topicUsing Worklist Feeds

Worklist feeds are secured by user ID. The worklist user must have access to the service operation PTFP_FEED. This access is included in the permission list PTPT1000, which is in the role PeopleSoft User. When a user is signed on to PeopleSoft Pure Internet Architecture, the user can view the feeds by selecting any of the following navigation paths:

This example shows a Worklist Notification on the Feeds page:

When you click the Worklist item, the appropriate page will appear.

You can subscribe to the feed and select the desired feed reader to use.

When you select a worklist item from a feed reader outside of the PeopleSoft system, the PeopleSoft sign-on screen will appear. Sign into the PeopleSoft system to view and work the worklist item.

Click to jump to parent topicManaging Worklist Feeds

Access the Publish as Feed (PTFP_PUB_AS_LIST) page (click the Publish as Feed link from the Worklist page).

All of the published worklist feed definitions will appear. From this page, you can edit, delete, or add worklist feeds.

Edit

Use this button to open the Publish Feed Definition page, where you can edit the current published definition.

Delete

Use this button to delete the worklist feed.

Add Feed

Use this button to define and publish a new worklist feed.

Return

Returns the user to the previous page.