Related-To filtering is a powerful way to filter items based on how the items are connected, rather than the item attribute values.
The related-to filter can be specified in the enterprise filter and the base filter, although they behave slightly differently in each case (the base filter has more control).
The simplest place to start understanding this capability is using the Base Filter:
Each filter has a specific role and function to provide more flexibility and control when looking at a view. These are listed below in conjunction with the image above:
- Adds items to the view that meet the filter criteria(s).
- Adds all items that are directly connected to specified item(s).
- From the result of filters, A & B, the relationships between those items will be included.
- Only allow items through the filter that meet the filter criteria(s).
- Only allow relationships through where both ends of the relationships have passed through filter D and that meet this filter criteria(s).
- Based on the items and relationships that made it through, further reduce to items connected to these items. These items do not need to have existed in D.
- Further reduce the items to this filter.
- Further reduce the relationships.
Once the Define Filter dialog is open, navigate to the Related Items tab as shown below:
In the tab, a list of items that are within the story will appear to choose from. By selecting an item or a set of items, it is configuring the filter to display the items that are related to those chosen items.
In the bottom right-hand section of the dialog box, the relationship setting can be configured between different behaviours to achieve the desired outcome. The settings to choose from are:
- Directly Related Only (default) – This will display items that are directly related to the chosen item(s).
- One level removed – This means for the chosen item, it will display items that directly related to them, and also the items that are directly related to the directly related items.
- Two levels removed – For the chosen items, it will return items that are 3 steps away in the directly related path.
- Up/Down Only – From the chosen item(s), it will return the items that are directly related to it in the categories both above and below the items category that has been chosen. From there, it will continue to find items directly related to the returned items in categories above/below them. It will not return any items that exist in the same category.
Note: To see examples of these setting configurations, view the Knowledge Base article titled: Behaviour on Click & Radial View (Relationship View).
Once the preferred relationship setting has been chosen and the item(s) of interest have been selected, pressing OK or OK and Save will return you to the view with the filter results being displayed, just like the example below:
The above example shows Related Items to the items named “Brexit” and “Resource Scarcity” with a relationship setting of Up/Down only.
Creating a Related To Filter in the Enterprise Filter:
Just like the Base Filter, the Enterprise Filter also has the capability of returning items that are related to a common item/set of items. The difference being that the Enterprise Filter will increase the number of items available to the view by bringing in items from other stories in the Enterprise Solution.
Setting the Related To filter for the Enterprise Filter can be achieved as shown below:
With the Enterprise Filter, any item from across the Enterprise solution that the user has access to can be chosen as the item to return and its directly related items.
The only relationship setting for the Enterprise Filter is Directly Related only.
When using the Enterprise Filter, there is a setting which determines the maximum number of items that can be returned into the source story, by default, it is set at 500. This can be amended if required in the section highlighted in the above image.
Related To Filter in the Interactive Filter:
With the Interactive Filter, there are 2 ways of using the Related To filter. Technically, for both ways, it is setting the Base
Filter in an interactive way, which is always good to keep in mind for when needed to clear a filter selection.
Creating Interactive Labels:
In the Interactive Filter Knowledge Base article, it will walk-through how-to setup Interactive labels at the bottom of the screen. This article will just enhance that knowledge in relation to the Related To capabilities of SharpCloud.
In the Configure interactive Filter Labels dialog as shown above, there is a dropdown available to add attributes and calculated values to the interactive section at the bottom of the view. One section is the Related items section, which will display the categories within the story to choose from.
By selecting a category, it will create a label for each item that exists within that category to be displayed at the bottom of the view. When that label is selected, it will display that item and its related items.
The relationship setting that is set in the Base Filter will be adhered to when selecting the item, so in order to amend the setting, this action needs to be performed in the Base Filter as shown below:
Right Clicking on an Item:
The last way the Related To filter can be actioned is by right-clicking on an item directly as shown below.
By selecting Highlight Related Items, it will display only the items that are related to the chosen item. The relationship setting will be determined in the Relationship tab of the View Options in the View Setup. It will fade the other items out but keep the items in context of the view and in the position they hold when right clicked.
By clicking Show Only Related items, it will filter out all items that do not meet the relationship settings to the chosen item, instead of fading them on the view. This action can also be achieved when in the radial view and pressing “Show in View”.
Clearing the Related To Filter:
As the Related To filter is mostly controlled in the Base Filter, that is always the best place to check what filtering is currently in place. There are simple actions which can be performed in the dialog to clear the filters as shown here:
By Clearing Related items Filter, it will deselect any items that have been chosen to be a part of the chosen related items filter.
By clearing everything, this will remove ALL filter parameters in place across ALL filters in that Filter class, for example, it will clear all Base Filters but will not affect what Interactive Filters are in place.