Configure list controls

Open the list configuration page by performing the appropriate action for the
list version.

Version

Action

List v2

Right-click any column heading and select Configure > List Control.

List v3

Open the list title menu and select List
Control.

The List Control form appears.

Complete the form.

Note: The list control fields that are available for embedded lists are more
limited. Unless otherwise noted, the list control fields in the following
table are available for both standard and embedded lists.

Table 1. List Control form

Field

Description

Table

View the name of the table for the list or related
list. For example, Change Request
[change_request]. This value is set by
the system automatically.

Related list

View the name of the table and field that define the
related list. For example,
sysapproval_approver.sysapproval. This
value is set by the system automatically.

Label

Enter the label to display for this list. Allows an
admin to customize the label for a related list or list.
If not supplied, the default plural label for the file
is used. For example, the label for the Incident table
would be Incidents.

Omit new button

Select the check box to prevent the
New button from displaying on
this list. Clear the check box to display the
New button or to control the
New button with roles
(New roles field).

This
field is available for standard lists
only.

Omit edit button

Select the check box to prevent the
Edit button from displaying
on this list. Clear this check box to display the
Edit button or to control the
Edit button with roles
(New roles field). The
Edit button does not apply to
all lists.

This field is available for standard lists
only.

Omit if empty

Select the check box to omit the Related
List from the form entirely (no header)
if there are no entries for the Related
List.

Omit columns if empty

Select the check box for a top-level list to omit the
column headers AND filters/breadcrumbs for an empty
column.

Omit filters

Select the check box to hide filters or breadcrumbs
for this list. Clear this check box if you always want
filters or breadcrumbs or to control filters/breadcrumbs
with roles (Filter roles field).

This field is available for standard lists
only.

Omit links

Select the check box to hide links for fields that
reference other files in this list. Leave this button
unchecked to generate links or to control the use of
links with roles (Link roles
field).

Omit drill-down link

Select the check box to disable the link to the
record from the first column in list view. Users can
still click the reference icon to access the record.

This field is available for standard lists
only.

List edit type

Controls the ability of a
user to edit values directly in individual cells in a
list. The options are:

Save immediately (cell edit
mode): enables cell editing. The
entire row is saved when the user enters a new
value.

Save data by rows:
enables cell editing. The row is saved only when
the user navigates away from the row or clicks the
Save icon (). This mode allows the user to modify
multiple values before saving a record.

Disable list editing:
prevents users from editing cells in the
list.

This field is available for standard lists
only.

List edit tag

Enter an arbitrary string of letters or numbers to
create a unique tag that is sent to a reference qualifier as the script variable
listEditRefQualTag.

List edit insert row

Select the check box to
enable or clear the check box to disable the ability for
a user to create new records in list view. When it is
enabled, an empty row appears at the bottom of the
list.

This field is available for standard lists
only.

Note: Enabling this setting renders the
list incompatible with List v3. The list always
renders in List v2, even if List v3 is
enabled.

Hierarchical lists

Inserts a hierarchical list into a record list.
Hierarchical lists enable a user to view the contents of
a record's related lists without leaving the record list
form.

This field is available for standard lists
only.

Note: Enabling this setting renders the
list incompatible with List v3. The list always
renders in List v2, even if List v3 is
enabled.

Edit default filter

Specify the filter to apply by default when this list
is opened. The edit default filter control is specific
to related lists. The option does not appear for
standard lists.

New roles

Specify the user roles that can access the
New button on this list.
Leave the field blank to enable all users to access the
New button. This option does
not apply to embedded lists, which do not contain
New buttons.

Edit roles

Specify the user roles required to have the
Edit button appear in the
list.

This field is available for standard lists
only.

Filter roles

Specify the user roles required to have the filter
appear in the list.

This field is available for
standard lists only.

Link roles

Specify the user roles required to have links
generated for fields that reference other files.

This field is available for standard lists
only, when List v3 is activated.

Example of configuring list controls

The following example shows how to configure a list of related incidents in a problem
record to suit specific business needs.

Before you begin

Role required: personalize_control

About this task

In this example, a related list label is configured to say Child
Incidents, not just Incidents. The related
list is also configured to remove the New button to prevent
users from creating new incidents from the Problem form.

Procedure

Navigate to a problem record.

Open the list context menu in the Incidents related list
and select Configure > List Control.

On the List Control form, change the Label field to
Child Incidents.

Select the Omit new button check box.

Click Submit to save your changes and return to the
previous record, in this case, the problem record.

In the problem record, the label for the embedded incident list has changed
and the New button is no longer available.