Tags: Reference selector

Reference Selector

This page briefly introduces the Reference Selector overlay and its basic functions.

When editing a reference field (inline edit by double click ► Item Edit page), use the pencil icon to open the Reference Selector overlay.

The possible reference filed types (datasources) can be selected from a drop-down list:

Options
Users
Projects
Trackers
Work/Config items
Repositories

Reference Selector of Work/Config items type fields

Basic functionalities

More functionalities were implemented for the Work/Config items type reference fields including layout, filters and storable Reference views

[!2021-04-30_11h46_48.png!]

EditTracker Item type reference field by clicking on the pencil icon.

[!2021-04-30_13h31_05.png!]

The Reference Selector overlay is based on the Table View layout:

The Table View layout is also dynamic: columns can be added, removed and moved.

According to the reference field configuration, filtering options are available, including Group by, Order by.

Reference Views

Reference Views can be edited, deleted and also saved as Private or Public Views. Each reference field has its own Public and/or Private Views.

Display Public Views of Referenced Trackers

Since codebeamer 21.09 (EMMA), there is a new functionality to display the Public Views of the Referenced Trackers.

Limitations:

The Public Views of a Referenced Tracker are displayed if a tracker is selected as a referenced tracker for a field
The Views tree structure is read-only. Views can be amended in the Manage Tracker Views option
For the Release type reference fields, this functionality is disabled

Other functionalities

A warning is displayed when:

pre-filters of the reference field are set (e.g. Resolved/Closed, other custom filters),
static/dynamic dependencies are present.

[!warningMessage.png#c211353f8e7991fc0e389cf41413df59!]

Reference Items Dialog

Since Codebeamer release HUSKY, the UI of the Reference Items dialog has been rationalized, making it more user friendly.

[!Release.jpg#56bb3e2d79466c7368af6bbd6eed61b7!]

In a tracker when selecting a common reference field for filtering, the Advanced Settings is collapsed in the Filter by Reference Items section, as the Project and the Tracker selections are automatically performed.

The focus is placed on the Work Items field. Clicking the pencil icon opens the Choose Items window where further filters can be added.

The Filter by Name of Reference Items section is unchanged.

Hovering over the question marks, further information and instructions are displayed in tooltips.

Exceptions

The simplified UI of the reference item dialog is the same for most reference item fields, however, there are exceptions which are detailed in the below tables.

Reference Field	Description
Parent	The dialog consists of the Advanced Settings section and the Work Items section. The Advanced Settings is collapsed as the Project and the Tracker are pre-selected but can be expanded and edited. The focus is on the Work Items section.
Children	The dialog consists of the Advanced Settings section and the Work Items section. The Advanced Settings is collapsed as the Project and the Tracker are pre-selected but can be expanded and edited. The focus is on the Work Items section.
Downstream Reference To	The Advanced Settings section is expanded as it has more importance in this case. By default, the first project from the Recent Projects list is selected as the Project, and its first tracker is selected as the Tracker, however, the relevant Project and Tracker must be selected by the user. The application of any Suspected References filter is optional. The Filter by Work Items section with the Work Items selector is collapsed, but can be expanded and edited. The NOT option can still be enabled, while the EMPTY option is removed from the dialog.
Upstream Reference To	The Advanced Settings section is expanded as it has more importance in this case. By default, the first project from the Recent Projects list is selected as the Project, and its first tracker is selected as the Tracker, however, the relevant Project and Tracker must be selected by the user. The application of any Suspected References filter is optional. The Filter by Work Items section with the Work Items selector is collapsed, but can be expanded and edited. The NOT option can still be enabled, while the EMPTY option is removed from the dialog.
Has Association To	The Advanced Settings option is expanded. By default, the first project from the Recent Projects list is selected as the Project, and its first tracker is selected as the Tracker, however, the relevant Project and Tracker must be selected by the user. The application of any Suspected References filter is optional. Although, the application of any Association Type is optional, its usage is recommended. The Filter by Work Items section with the Work Items selector is collapsed, but can be expanded and edited. The NOT and EMPTY options are not available on this dialog.

Reports and the Planner View are also exceptions.

Exception	Description
Reports	Unlike in tracker context, the Filter by Reference Items section is expanded. By default, the first project from the Recent Projects list is selected as the Project, and its first tracker is selected as the Tracker, however, the relevant Project and Tracker must be selected by the user. The application of any Suspected References filter is optional. The Work Items field is included in this section. If the Tracker and a reference field is known, the Filter by Reference Items section is collapsed.
Planner View	In case the Project and the Tracker filters are set to Any, the Filtering by Reference Items section is expanded on the dialog. By default, the first project from the Recent Projects list is selected as the Project, and its first tracker is selected as the Tracker, however, the relevant Project and Tracker must be selected by the user. The application of any Suspected References filter is optional. The Work Items field is included in this section.

The reference items dialogs operate the same way with the exceptions everywhere within Codebeamer when editing the reference field of an item.