Worklist
A worklist is an SAP Fiori elements floorplan for processing a known collection of work items in a table without a full filter bar, often split into status tabs with item counts. A worklist focuses on completing or delegating items, and in SAP Fiori elements for OData V4 it is a list report configured without a filter bar.
Quick facts
- Type
- SAP Fiori elements floorplan (page template)
- Layer
- UI applications
- Technically
- Simplified list report; own template in OData V2, hideFilterBar setting in OData V4
- Driven by
- UI.LineItem, UI.SelectionVariant or UI.SelectionPresentationVariant for tabs
- Typical pairing
- Object page for the details of each item
- Who works with it
- SAP Fiori developers, UX designers, clerks and buyers working through queues
- Applies to
- SAP S/4HANA (all deployment options), SAP BTP
Layer: UI applicationsWhere it sits ▾
Layer: UI applications
Open the architecture map →When should you use a worklist?
A worklist fits when the set of items is already defined by the task and the user's job is to work through it: purchase requisitions waiting for a buyer, documents with a missing field, deliveries to confirm. Processing usually means opening an item, reviewing it, and then completing it or handing it on.
The decision criterion is where the selection effort sits:
- If users must combine several criteria before the list makes sense, use a list report.
- If the list is predefined and users mainly act on it, use a worklist.
- If the items are workflow tasks routed to the user by a workflow engine, My Inbox already provides the inbox, with decisions, forwarding and substitution.
Example: the purchasing team at Alder Manufacturing opens a worklist of purchase requisitions, sorted into tabs by status, and processes the open requests from Cedar Office Supply and Bright Freight one by one. A worklist is the right choice when processing, not searching, is the first step of the task.
What are the parts of a worklist?
A worklist page has four regions, top to bottom:
- Header title: the name of the work queue, without the variant-heavy header of a list report.
- Tabs by status: optional views, defined by developers, that split the items into groups such as open, in process and completed. Each tab can show the number of items it contains.
- Search field: a free-text search in the table toolbar, which replaces the filter bar.
- Table: the items themselves, with actions in the toolbar or on each row and navigation to an object page for details.
In SAP Fiori elements for OData V2, the worklist uses a responsive table by default, shows the row count in the table title and hides variant management unless the developer enables it. The V2 worklist also offers no export to spreadsheet. A worklist trades the filter bar for a flatter page that puts the items and their actions first.
How is a worklist configured in OData V2 and V4?
The setup differs between the two SAP Fiori elements variants:
| Aspect | OData V2 | OData V4 |
|---|---|---|
| Template | Worklist Page, chosen in the SAP Fiori application generator | List report template with the manifest setting hideFilterBar |
| Search | Search field in the table toolbar | Search field in the table toolbar |
| Initial load | Not documented separately; the list report options apply | Content always loads, whatever initialLoad says |
| Variant management | Hidden by default; variantManagementHidden and smartVariantManagement enable it | Not documented separately; check the list report variant settings |
Status tabs are multiple views. Developers define them with UI.SelectionVariant or UI.SelectionPresentationVariant annotations and list them in manifest.json. In V4, multiple table mode renders an icon tab bar, and the showCounts option, off by default, adds the item count to each tab. Table columns come from UI.LineItem, and each tab can point to its own line item through a presentation variant. Configuring a worklist is therefore mostly list report configuration with the filter bar removed.
Can you extend a worklist?
Yes. SAP documents the worklist as a simplified list report, so the list report options apply:
- Your own app: extension points add custom columns, actions and views; in OData V4, building blocks and custom pages from the flexible programming model cover larger gaps. Custom views can also be added as extra tabs through a controller extension.
- An SAP-delivered app: adaptation projects created with SAP Fiori tools, or key user adaptation, change the app without modifying SAP's code.
In SAP S/4HANA Cloud Public Edition, check which of these paths SAP supports for the app in question.
A practical limit: once users ask for several filter fields, the requirement has turned into a list report, and re-enabling the filter bar is more honest than building custom filters around a worklist. Extending a worklist works well for actions and columns, less well for search.
What are common worklist design mistakes?
- Using a worklist for open-ended search. Without a filter bar, users scroll and search instead of selecting; a list report fits better.
- Pointing it at a huge entity set. A hidden filter bar means content loads at start, so the tabs' selection variants must already narrow the data.
- Overlapping tabs. If one item can appear in two status tabs, counts no longer add up and users distrust the queue.
- Expecting live counts. In OData V4, refreshing a tab's count through a global side effect works only for a view the user has already opened, so plan how counts update after actions.
- Rebuilding My Inbox. Modeling workflow approvals as a custom worklist duplicates forwarding, substitution and task handling that My Inbox already provides.
When counts look wrong, check in order: the selection variant behind each tab, overlaps between tabs, and whether the tab was refreshed after the last action. Most worklist problems are selection-design problems, not framework defects.
Worklist vs. list report vs. My Inbox: what is the difference?
| Worklist | List report | My Inbox | |
|---|---|---|---|
| What it is | SAP Fiori elements floorplan | SAP Fiori elements floorplan | SAP Fiori app (F0862) for workflow tasks |
| Main task | Process a known set of items | Find and act on objects in a large set | Decide on tasks routed by a workflow |
| Where items come from | An OData entity set, narrowed by tabs | An OData entity set, narrowed by the filter bar | Workflow engines, through the Task Gateway service |
| Filtering | Search field and status tabs | Full filter bar with variants | Task filters, sorting and grouping |
| In SAP Fiori elements for OData V4 | List report without filter bar | Floorplan of its own | Not an SAP Fiori elements floorplan |
A worklist and a list report are two configurations of the same technology, while My Inbox is a dedicated app for workflow tasks.
FAQ
Is the worklist still available in SAP Fiori elements for OData V4?
Yes. In SAP Fiori elements for OData V4, the worklist is a specialized configuration of the list report rather than a separate template. Developers set hideFilterBar in manifest.json, and the page then shows a search field in the table toolbar and always loads its content.
What is the difference between a worklist and My Inbox?
A worklist is a floorplan that any app can use to list business objects for processing, such as purchase requisitions. My Inbox is one specific SAP Fiori app that shows workflow tasks from SAP Business Workflow and other task providers, with decision options, forwarding and substitution.
Can a worklist show item counts on its tabs?
Yes. Status tabs in a worklist are multiple views defined with selection variants. In SAP Fiori elements for OData V4, the showCounts option of multiple table mode displays the number of items on each tab; it is switched off by default.
Can users filter a worklist?
Only in a limited way. A worklist offers a search field, sorting and developer-defined tabs, but no filter bar. When users regularly need several filter criteria to find their items, a list report is the more suitable SAP Fiori elements floorplan.
Does a worklist open an object page?
Usually, yes. Choosing a row in a worklist navigates to the object page of that item, where the user reviews the details and completes the work. Simple actions can also run directly from the worklist table without opening the item.
Sources
- SAPUI5 SDK: Worklist Page (SAP Fiori elements for OData V4)
- SAPUI5 SDK: Worklist Page (SAP Fiori elements for OData V2)
- SAPUI5 SDK: Configuring Filter Bars, including hiding the filter bar (OData V4)
- SAPUI5 SDK: Defining Multiple Views in a List Report Page Table, Multiple Table Mode (OData V4)
- SAPUI5 SDK: Standard Floorplans (SAP Fiori elements for OData V4)
- Applies to
- SAP S/4HANA on-premise · SAP S/4HANA Cloud Private Edition · SAP S/4HANA Cloud Public Edition · SAP BTP
- Last reviewed