SAP Fiori Elements Framework List Report / Worklist Header

Updated: October 5, 2022
SAPUI5 Version 1.98

List Report – Header

Intro

The SAP Fiori elements list report template supports the features and settings for the list report header detailed below.

For design information, see the List Report Floorplan guidelines and the links below.

Warning
Put all controls for searching and filtering data in the list report filter bar.

Do not include the search or filter options that are available in the table header.

Feature Availability

 

Features

  

Availability
Page-Level Variant Management Default, you can turn it off.
Share Menu Default
Manual Update Mode Default
Live Update Mode Available with SAP Fiori elements for OData V2 only
Search Available
Filter Bar Default
Initial State of Header Default:

  • Expanded on large screens
  • Collapsed on medium and small screens when the application is configured to load the list report data on app launch
Pin Button With SAP Fiori elements for OData V4, turned on when the list report contains at least one responsive table.
Editing Status Filter Default for draft-enabled applications
Input Controls for Filters Default
Adapt Filters UI Element
  • Default: dialog with SAP Fiori elements for OData V2
  • Default: popover with SAP Fiori elements for OData V4

Feature Details


Page-Level Variant Management

By default, page-level variant management is enabled and the header displays a page title.

You can disable it.

Guidelines
If you disable page-level variant management, you must display a header title.

For more information, see Header Title.


Share Menu

By default, the header contains:

  • The generic Share menu with the global actions Send Email and Save as Tile.  
  • Share in SAP Jam, when SAP Jam integration is configured.

For more information, see:


Update Mode

By default, the update mode is manual.

You can enable live update mode instead with SAP Fiori elements for OData V2.

For more information, see Live Update / Manual Update.


By default, the search is disabled.

You can enable it.

Guidelines
Work with the development team to define the searchable properties in the data.

For more information, see Search.


Filter Bar

SAP Fiori elements for OData V2 uses the smart filter bar.

SAP Fiori elements for OData V4 uses the filter bar.

Warning
Put all controls for searching and filtering data in the list report filter bar.

Do not include the search or filter options that are available in the table header.

Initial State of Header

The default behavior is shown below:

Screen Size

Application Starts with Data

Application Starts without Data
S Collapsed Expanded
M Collapsed Expanded
L Expanded Expanded
XL Expanded Expanded

Pin Button

With SAP Fiori elements for OData V4, the Pin  /Unpin   buttons are displayed under the header when a list report contains at least one responsive table,

The pin option keeps the header collapsed or expanded when the user scrolls.

The grid table and the analytical tables are not scrollable so the Pin  /Unpin  buttons are not displayed when the list report contains only these types of table.

For more information see, Pinning the Header Content.


Editing Status Filter

By default, the filter is enabled for draft-enabled applications.

The filter values and corresponding results are as follows:

  • All (Default value):
    • All saved (or active) versions of the documents for which the current user has no drafts
    • All the users own drafts of unsaved changes to existing documents. The version last saved before the user began editing the draft is not shown in the results.
  • All (Hiding Drafts): Only the saved objects.
  • Own Draft: Drafts that the current user can display or edit.
  • Locked by Another User: Saved versions that are locked by other users. The current user cannot edit these versions.
  • Unsaved Changes by Another User: Saved versions that were edited by another user but are no longer locked. The current user can edit and overwrite these versions, and the previous draft will be overwritten.
  • No Changes: Saved versions with no corresponding draft.

For more information, see Draft handling.


Input Controls for Filters

You can decide which filter/input controls to use and set the following for them:

  • The properties available as a filter criterion
  • The labels for the filter fields
  • The default filter values
  • Mandatory filters: Marked by an asterisk (*), they always show in the filter bar.
  • Type-ahead for values entered
  • Value help lists

You can also:

  • Decide on the selection controls for the filters
  • Restrict the values accepted in the field. By default, the field accepts multiple values.
Guidelines
Date Picker and Date / Time Picker

By default, filter fields for the date picker (sap.m.DatePicker)and date/time picker (sap.m.DateTimePicker) result in a control that opens a dialog for adding multiple dates.

When your use case requires a date/time picker for a single value, specify this to the the application developers because it requires explicit configuration.

For more information refer them to: Configuring Filter Fields.

For more information, see:


Adapt Filters

By default, SAP Fiori elements for OData V2 uses the Adapt Filters dialog and SAP Fiori elements for OData V4 uses the Adapt Filters popover.

You can configure the following:

  • Filters that are initially visible in the expanded filter bar. When you set filters to be visible by default, they are displayed under the Basic group in the dialog.
  • Additional groups for the filters
  • Show input fields: Visible by default. You can hide the Hide value/Show value button.

Users can add additional fields through variants.

The OK and Cancel buttons are displayed when the application team or the user has chosen manual update mode for the filter bar.

By default, the Reset button is displayed, you cannot change this.

For more information, see: Adapt Filters.

Related Links

Elements and Controls

Implementation