This page describes how to define a record view and style your record header.
Once you’ve configured the source of your record type, each row of your source data will be displayed as a record. To extend your data, you should consider what users will want to see and do from the context of each record.
Specifically, you’ll want to think about:
Let's break it down with an example. If you are working with a Customer Support record type, first consider who will want to view the information on each record. In this example, support engineers and case managers need to view and monitor each submitted customer case.
Once you know who will view the record, what information they will want to see? The support engineer may only need to view who submitted the case, the details about the issue, and the date the case was submitted. The case manager, on the other hand, may want to view the total number of supported cases from the customer, their sentiment score, and their payment plan.
When you know who will view the records and what information each type of viewer will want to see, you can define your record views. Record views are design elements that you can use to tailor record data to a user’s interests and needs. You can have multiple record views to create a more comprehensive view of your data that benefits many users.
In the Customer Support record type, you could create two different record views: one for support engineers that displays the details of the case, and another for case managers that contains information about the customer’s sentiment score, case history, and payment plan.
Once you define your record views, learn how to create record actions so users can take action from the context of a record.
If you are working with an existing record type created in 20.2 or earlier, update the record type to use new record type object components, features, and functions.
A record view is defined on the record type object and is comprised of an interface that displays information from a single record to end users. You can have multiple record views to surface different insights about each record depending on a user’s interests and needs.
Although each record in the record type will contain the same record views, the layout and data that display for each record is determined by the expressions used to define the views. By default, each record type will have at least three views:
The Summary view is displayed by default as the first view on a record. You can define the Summary view and up to 20 additional record views on your record type. The News and Related Actions views are configured out-of-the-box on the record type to display any news related to a record and any related actions associated with the record type. These two views are pre-configured to save development time, so they cannot be modified.
In order to define a record view, first create an interface object to display the record data. To easily pass data into your interface object, use the record type as a rule input in your record view interface. To learn more about creating a record view and passing the record data, see Create a Record View.
By default, each record will have a Summary view. This is typically the first view a user sees when clicking on a record in the record list. Users can navigate to this view from a column in a grid-style record list, or from the main text in a feed-style record list.
To define the Summary view:
In the views grid, click Summary.
In the example below, the expression rule!P_PurchaseOrderDashboard(rv!identifer)
is used to call the interface and pass in the record's ID. For more information on rv!
, see Domain Prefixes.
In addition to the Summary view, you can have up to 20 record views.
To add another view:
Click New View.
A record type has two record views that are configured out-of-the-box and displayed by default on each record:
Since these record views are auto-populated with related news events and related actions, they cannot be modified.
There may be cases when you don't want to display the News view or the Related Actions view on your records. For example, you may want to hide these views if your application doesn't utilize the News feed, or you've used the record action component to display related actions on your interfaces.
When you don't want to display the News or Related Actions views, you can hide them to prevent users from navigating or seeing these views on the records. You can determine whether or not the News or Related Actions view is displayed by selecting the Show News view or Show Related Actions view checkbox on the Views page.
When you choose to show or hide either of these views, you are determining the view's visibility. This means that if you configure the record type to hide a view, users will not be able to see or interact with the view anywhere in the application. For example, if you configure a site to display the News view, but you've hidden the view on the record type, the News view will not display on the site.
Hiding the Related Actions view does not determine the security of the related actions. Users can still perform related actions from related action shortcuts, the record action component, or by navigating to the URL for that related action if they have the proper security permissions to do so. To restrict permissions on related actions, configure the underlying process model's security.
Once you've created your record views, think about adding some final touches on the record's presentation. To start, each record will need a title that displays in a record header.
The record title appears at the top of each record view, in record tags, and in the hover card for that record.
The way you define the record title will vary depending on whether you plan to display your list of records as a grid-style or feed-style list.
For grid-style record lists, go to the Views page of the record type. You can configure a specific expression for each record title in the Record Title field. For example, the image below uses the expression rv!record[recordType!purchaseOrder.fields.purchaseOrder]
to display each record's purchase order number as the title.
For feed-style record lists, the record title comes from the title
parameter in a!listViewItem
when you define the record list. Learn more about the listViewItem function
The record header appears at the top of each record view as the background and contains the title, breadcrumbs, and related actions. Record headers can be styled using colors or a billboard image. By default, the record header style is NONE.
Headers can display one background color for all records in a record type, or different colors based on an expression or variables within the record.
The record header will display the selected color style with the record title, breadcrumbs, and related action buttons in the card.
You can use one of the following options to set the background color:
TEXT
.You can configure headers to display one image or multiple images. One image from a document or a URL can be used for all records in a record type. Similar to color backgrounds, you can also configure image backgrounds to display different images based on variables within the record or using an expression.
The record header will display the billboard image of your choice, where you can style the overlay, height, and background color. The overlay will contain the record title, breadcrumbs, and related action buttons.
The following table lists the options you can use to style the image background:
Style | Options |
---|---|
Image Height | Short , Medium , Tall , and Auto . |
Overlay Type | Bar and Full . |
Overlay Position | Top , Middle , and Bottom . |
Overlay Style | Dark , Semi-Dark , None , Semi-Light , and Light . |
Background Color | Any valid hex code. |
If you use variable or expression to configure the image background, the live preview will not display the selected image.
To configure the Document option for an image:
To configure the URL option for an image:
To configure the Variable option for an image:
From the Color dropdown, select the record variable of your image. This picker returns record variables of type TEXT
, INTEGER
, and DOCUMENT
.
To configure the Expression option for an image: