Updated: October 27, 2021

Object Page – Header

Intro

The SAP Fiori elements object page template supports the features and settings for the object page header detailed below.

For design information, see the Object Page Floorplan guidelines and the links below.

Warning
Always build the object page using the dynamic page header.

Set the shellbar page title to the name of the business object shown in the object page to indicate the user’s position in the system.

Do not use the current implementation of the “page variant” feature in SAP Fiori elements. This feature is technically available for object pages, but we are still working on the final design.

Feature Availability

 

 

Behavior and Interaction

 

Availability

Expanded State Default on initial load
Collapsed State Default on scroll
Header Content Displayed in the Header Content Area and the Header Section Default in create and edit modes
Header Content Visible Default, you can hide it.
Header Content Hidden Available
Making Header Fields Editable Available
Highlighting Values Based on Criticality Available
 

Components

 

Availability

Dynamic Page Header Mandatory, it must be configured.
Title Mandatory, you must define it.
Breadcrumbs Default
Subtitle Available, you define the text.
Object Marker Default in draft-enabled applications
Image Available
Paging Buttons on the First Object Page Available with SAP Fiori elements for OData V2 only
Paging Buttons on the First Subobject Page Default under certain conditions
Toolbar Available
 

Toolbar Actions

 

Availability

Edit and Delete Default, when the data allows these actions.

You can turn one or both actions off.

Related Apps Menu Button Available

With SAP Fiori elements for OData V4, you can change the button name to Open in…

Display Saved Version/Return to Draft Button Available
Generic Actions Default: Share is turned on for saved objects and turned off for drafts.
Application-Specific Actions Available,  they must be configured.
Conditional Enablement of Navigation Buttons Available with SAP Fiori elements for OData V4

Requires an extension with SAP Fiori elements for OData V2

Order of Toolbar Actions Default

You can change the default order.

 

Additional Content (Optional)

 

Availability

Simple Header Facets Available with SAP Fiori elements for OData V2 only
Plain Text Facets Available
Contact Facets Available
Micro Chart Facets Available
Form Facets Available
Address Facets Available
Header Field Group Available
Rating Indicator Facets Available
Progress Indicator Facet Available
Key Value Facet Available
Link Available

With SAP Fiori elements for OData V2, the default link shows the text and ID. You can remove the text or the ID from the link.

Behavior and Interaction


Collapsed/Expanded State

  • On the initial load of the object page, the header is expanded.
  • When the user scrolls down the page, the header collapses.

Display of Header Content

In display mode, the header content area displays all the header content.

In edit and create modes, the header content is displayed in two places:

  • The header content area, at the top of the page, displays uneditable header content. By default, all header content is uneditable. You can make specific fields editable. See Making Header Fields Editable below.
  • The Header section, the first dynamic section in the content area, displays editable header content. It’s only present in the edit and create modes.

For more information, see Dynamic Page Header (Mandatory).


Header Content Visibility

By default, header content is visible.

You can set the following header components or selected content, fields, or actions in them to be displayed or hidden, according to the object’s state:

  • Entire header facets
  • Content, such as fields, in a header facet
  • Content in quick views

With Fiori elements for OData V2, you can set:

  • The header to be displayed in edit mode.
  • Header facets to be visible in edit mode.
Developer Hint
For more information on the features, refer the development team to:


Making Header Fields Editable

You can make fields in the object page header editable in edit mode.


Highlighting Values Based on Criticality

You can assign colors and icons to text to indicate the criticality of a field value.

Components


Title

By default, with:

  •  SAP Fiori elements for OData V2, the title area is empty.
  •  SAP Fiori elements for OData V4, the title area displays the text: (Unnamed Object).
Guidelines
Tell the developers which property to use as the title.

Breadcrumbs

Breadcrumbs are displayed above the object title.

Guidelines
Limit the breadcrumbs to the drilldown levels within the object page.

Object Marker

The object marker indicates the object is locked by another user in draft-enabled applications.


Image

The image is an avatar control. By default, it has a square shape.

You can set:

  • An image to display instead of the avatar.
  • The avatar to a have a circular shape.

When no image is set or found for the avatar, the avatar initials are displayed.

If those are not set or found either, an icon for the avatar is displayed:

  • A square avatar for a product
  • A circular avatar for a person.

For more information on the logic used for displaying an object, consult the development team and see Using Images, Initials, and Icons.


Paging Buttons

By default, with both SAP Fiori elements for OData V2 and V4, the paging buttons appear in the subobject page of applications that use the dynamic page layout in the following conditions:

  • The user has navigated from a table in the object page to the subobject.
  • The table in the object page contains at least two items.

With SAP Fiori elements for OData V2, you can:

  • Enable the paging buttons to show on the first object page opened from a list report.
  • Disable the default display of the paging buttons on the subobject page.

Toolbar Actions


Edit and Delete

By default, these actions are displayed when the data in the object page allows them.

You can:

  • Set each enabled action to be displayed or hidden based on certain conditions in the back end. For example, you can hide the actions for a sales order that has already been paid.
  • Disable the actions.

For more information, see:


Related Apps Menu Button

You can enable the Related Apps menu button. It displays the actions available on the same object in different applications. Users select the action to open the same object in another application.

You can also:

  • Hide specific actions in the menu.
  • Change the button name to Open In…  with SAP Fiori elements for OData V4.

Display Saved Version / Return to Draft

You can display this button on the object page to allow users to choose between a display of the saved or the draft version of the object page record:

  • Display Saved Version displays the last saved version of the object page record.
  • Return to Draft displays the object page in edit mode.

This feature is enabled at the application level and also displays the Hide Draft Values / Show Draft Values button in the list report toolbar for the table that displays the objects.

The selection in the list report determines the state of the object that opens when the user navigates to the object page:

  • From a list report with Hide Draft Values selected, the object page opens with the last saved version of the record. If a draft record exists, the object page also shows the Return to Draft button. 
  • From a list report with Show Draft Values selected, the object page opens in edit mode for drafts and shows the Display Saved Version button.

When the user navigates back to the list report, it displays with the previously selected state.


Generic Actions

By default, the Share button is displayed for saved objects and hidden for drafts.

For more information, see Share (Generic).


Application-Specific Actions

You can include the actions required for your use case.

The header toolbar displays application-specific actions to the left of the generic actions.


Conditional Enablement of Navigation Buttons

With SAP Fiori elements for OData V4, you can enable buttons that navigate the user to another page or application based on the value of a specific field.

With SAP Fiori elements for OData V2, this feature requires extensions.

For example, you can enable the Generate Purchase Order button only for sales orders with the completed status.

Guidelines
Implement this feature only when the way to enable the button is obvious to end users.

Order of Toolbar Actions

The default order — left to right — for actions in the object page toolbar is below:

You can rearrange the order, for example, by setting an application-specific action that’s the primary action to the leftmost position on the toolbar.

For more information, see:

Additional Content


Simple Header Facets

With SAP Fiori elements for OData V2 only, you can use a simple header facet to show simple data points that align horizontally across the header.


Plain Text Facets

You can use the plain text facet to display a continuous text in the header.

For more information, see Plain Text Facet.


Contact Facets

You can enable a quick view for a contact.

For more information, see Quick View.


Micro Chart Facets

You can display the following microcharts in the header:

  • Area micro chart
  • Bullet chart
  • Radial chart
  • Column chart
  • Line micro chart
  • Harvey ball chart
  • Stacked bar chart

For more information, see Micro Charts.


Form Facets

You can add a quick view to the form facet.

For more information, see Form Facet (Dataset).

Developer Hint
For more information, refer the development team to Form Facet.

Address Facets

You can display an address such as a shipping address.

Developer Hint
For more information, refer the development team to Address Facet in the Object Page Header.

Header Field Groups

You can define fields to display together in a facet. For example, for the product object, in the General Information section, you can include the fields quantity, weight, and supplier.


Rating Indicator Facets

You can add a rating indicator to the header. It is read-only in both display and edit modes.

By default, the maximum rating is five stars.

You can:

  • Change the maximum rating.
  • Specify more descriptive text for the subtitle.

With extensions, you can make the rating editable.

Display Mode

The rating indicator shows with the:

  • Title
  • Subtitle with the total number of ratings
  • Rating shown with stars: Both the aggregated and non-aggregated single rating types are supported.

Edit Mode

The rating indicator moves into the header facet and appears with only the title in edit mode.

For an aggregated rating, the number of ratings is shown in parentheses after the stars.

For more information, see:


Progress Indicator Facets

You can add a progress indicator facet to the object header.

For more information, see:


Key Value Facets

You can add a key value facet to highlight important data or KPIs.

For more information, see Key Value Facet.

Related Links