A worklist displays a collection of items that a user needs to process. Working through the list usually involves reviewing details of the items and taking action. In most cases, the user has to either complete a work item or delegate it.

The focus of the worklist floorplan is on processing the items. This differs from the list report floorplan, which focuses on filtering content to create a list.

Usage

Use the worklist floorplan if:

• The user has numerous potential work items and needs to decide which ones to process first.
• You want to give the user a direct entry point for taking action on work items.
• Your app uses the full screen layout. The full screen worklist is preferable if the work items are complex objects. For simple scenarios, use the split-screen layout instead.

Do not use the worklist floorplan if:

• You want to create only a lightweight worklist. Instead, use the split-screen layout for simple scenarios.
• The items you are showing are not work items.
• You want to show large item lists, or combine different data visualizations (charts or tables). In this case, use the list report floorplan instead.

Layout

Responsiveness and Adaptiveness

Worklist Floorplan with the Dynamic Page Layout

Variant Management and Global Actions

The header title of the dynamic page provides a variant management option and a toolbar for global actions. If the content is collapsed, the header title displays the selected tab.

Dynamic Page Header

The dynamic page supports snapping behavior for the header content, including the tab bar:

• If the header is used with a responsive table (sap.m.table), the header content collapses automatically when the user scrolls down the page.
• If the header is used with a grid table, analytical table, or tree table (sap.ui tables), users can collapse the header manually.

Footer Toolbar

In edit mode or for finalizing actions there is a footer toolbar. This element appears on the bottom of the page content and contains finalizing actions.

Types

Simple Worklist

The worklist floorplan allows the user to work through a list of items. Ideally, the system provides the user with a complete list of work items in the correct order. You should also ensure that no important work items are lost, and keep distracting functions to a minimum.

The most basic version of the worklist is therefore a plain page with a list.

Category Worklist

The icon tab bar enables users to call up work items in specific categories. This can help users identify critical items more easily. Different tabs can also contain tables with different configurations (for example, with different columns or actions).

You can offer visual orientation by applying semantic colors to the icons for the different categories (for example, red on the Error tab).

KPI Worklist

The key performance indicator (KPI) worklist allows the user to track a KPI while processing the worklist. You can display the KPI in the subheader.

You can also offer actions at line item level. This reduces the interaction required to a single click per item. Consider offering actions at line item level for the most frequently used actions, and if the list provides enough information to make the a decision.

Often, users will need more information before they can take action. In this case, offer navigation to the work item details, and offer all the relevant actions in the detail screen.

Resources

Want to dive deeper? Follow the links below to find out more about related controls, the SAPUI5 implementation, and the visual design.