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

PeopleTools provides the WORKLIST feed data type to publish worklist feeds through the Feed Publishing Framework.

Worklist feeds provide the ability to view a user's worklist as a feed in real time. The feed is generated in the security context of the signed on user and displays the user’s current worklist items; however, it does not show worked items. By using worklist feeds, the worklist items can be available on systems other than the system that originated the entries without copying the data.

If worklist items are hosted on another system, then you must complete additional configuration in the local database for the node that represents that system.

Additional Configuration for Worklist Feeds

The local host node that contains the Worklist and Worklist Details pages must have defined content uniform resource identifier (URI) text and portal URI text. This configuration data will be used to generate the worklist item URLs. To find the node name, navigate to the Worklist page or the Worklist Details page and look at the URL, which will be similar to the following:

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

In the previous URL, ERP is the local host node; therefore, you must define the content URI text and portal URI text for the ERP node so that worklist feeds contain valid feed entries.

See Setting URI Text for Local Host Nodes.

Click to jump to parent topicPublishing Worklist Feeds

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

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

To publish a worklist feed:

Note. Any user with the role PeopleSoft Administrator can publish worklist feeds from either the Worklist page or the Worklist Details page.

  1. Select Worklist, Worklist to access the Worklist page.

  2. Click the Publish as Feed link.

    See Publishing Worklists as Feeds.

  3. On the Publish Feed Definition page, define the feed properties.

    See Defining Feed Properties.

  4. Click the Advanced Options link.

  5. Define the advanced feed options for the worklist feed.

    See Defining Advanced Options for Worklist Feeds.

  6. Click the OK button.

  7. Click the Publish button.

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

Page Name

Definition Name

Navigation

Usage

Worklist

WORKLIST

Worklist, Worklist

Create feed definitions for worklists.

Worklist

WORKLIST_DETAILS

Worklist, Worklist Details

Create feed definitions for worklists.

Worklist - Advanced Feed Options

WL_PUB_AS_ADVOPT

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

Define advanced options for worklist feeds.

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

Access the Worklist page or the Worklist Details page (Worklist, Worklist; or Worklist, Worklist Details).

Use the Worklist page to publish a worklist as a feed. Click the Publish as Feed link to begin creating the feed definition.

Create the feed definition on the Publish Feed Definition page.

See Defining Feed Properties.

Click to jump to top of pageClick to jump to parent topicDefining Advanced Options for Worklist Feeds

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

Use the Advanced Feed Options page to determine which worklists and worklist items are to be published in the worklist feed.

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.

Worklist Feed Parameters

Select the parameters and values for the worklists and worklist items that you want to publish. A status of 0 (available) or 1 (selected) will always be included in the feed parameters. 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.

Reset to Defaults

Click to reset advanced options to their default values.

Worklist Feed Parameters

This table lists worklist feed parameters, selectable values, and their data source parameter names:

Worklist Parameter

Values

Data Source Parameter

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 parameter 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, consider the following list of worklist feed parameters and runtime values:

Worklist Parameter

Runtime 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

The WHERE clause for the SQL statement generated for the 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 Feed Publishing Framework automatically maps the feed properties to Atom 1.0 data source parameters:

Feed Property

Data Source Parameter

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

You can view the feeds by selecting any of the following navigation paths:

The following example shows a feed titled Worklist Notification in the browser:

When you click a worklist item, the appropriate page will appear.