Document toolboxDocument toolbox

Predefined Filters

Predefined filters are established by an administrator and then shared with specific users or groups.

To create a presentation:

  1. Click on the Add button in the Manage Presentation Filters panel



  2. Fill in Name and Description

  3. Layer is optional (if provided with the ID of a layer, data for presentation will be taken only from the specified layer).

  4. Choose the Type of presentation (Standard, Automatic, By class).

  5. Count - when this is turned on, the column count will be visible showing the number of objects fulfilling each filter's requirements (defined by HQL).

  6. Spot area - Shows the area of all spots for each filter. This field excludes using custom column summary.

  7. Custom summary - This unlocks the Custom label, and the Summary suffix fields Turn off Spot Area option.

    • Custom label - name of custom column

    • Summary sufix - custom "units" for summary of presentation custom column. 

Each Predefined Presentation must have at least one Filter.

Presentation Types

Manual presentations

Sample manual presentation definition:

 

 

Filters definition for manual presentation:

  • Label - Choose a label for the filter.

  • Target Class - This is the class from which we want to show data (required).

  • Tool name - Select an existing Toolset or create a new one. This can be easily done from the Tool Picker window.

  • Summary field - Only visible when Custom summary option is turned on, then this option will appear (also on other presentation types). The custom column will display data from the Summary field for each filter.

  • HQL - HQL phrase that defines if the filter will be applied to Object.

  • Fields - The scroll menu helps choose the target class's field. Click to unlock fields list, choose a field and click on Add Field button.

  • Perspective Set (optional) - If this presentation is to be "indirect," it requires choosing Source Class as well.

  • Source class (optional) - For an indirect filter.

Automatic Presentations

When setting up automatic presentations, you have the option to include an optional HQL field. If specified, objects will undergo initial filtering by HQL and then be grouped by the designated target field. If not specified, they will simply be grouped by the target field without any prior filtering.

Here's an example of how filters can be used: Automatically filter spaces based on floor type where space area is greater than 2sqm. This means that only spaces with an area greater than 2sqm will be included in the automatic filter.

In Automatic presentation, there's no need to use the HQL language to define when the filter should be applied and you don't have to manually select any tools (colors are randomly assigned).

 

Defining filters for automatic presentation:

  • Label - Select a label for the filter.

  • Target Class - This represents the class from which data will be retrieved.

  • Summary field - When the Custom summary option is activated, this field becomes visible (also across other presentation types). The custom column will display data from the Summary field for each filter.

  • Target Field, choose target class field from which value will be taken into presentation.

  • HQL (optional) - If specified, objects will first be filtered by HQL and then grouped by the target field.

  • The scroll menu under Fields assists in selecting the target's class fields. Click to unlock fields list, choose a field, and click on Add Field button.

  • Show Empty Target Field (added only for Automatic presentations)
    When checked, Show Empty Target Field highlights objects with empty values in the Target field when applied, displaying them on presentation result window.

  • Perspective Set (optional) - If this presentation is intended to be "indirect," it necessitates choosing Source Class as well.
    It requires choosing Source Class if this presentation is to be "indirect."

  • Source class (optional) - Identifies the source class for an indirect filter.
     

 

In-direct Presentations - Filtering Data from Target Class

In indirect presentations, data from a different class than the source class is displayed.

These presentations can be of any type (standard, automatic, or by class), but they incorporate an additional

perspective that points to the source class to display related data on the presentation legend.

An example of this is to display all Rental Units using a presentation that draws a perspective showing spots connected to rooms.

  • To implement this, prepare a special perspective for use in the presentation. In this case, let's call it RU (this will be used in filter definition later on).
    For our example, we must prepare a Perspective Set with only two perspectives: "Rental Units" and "Rooms".

  • Please note that the connection to Rum from Rental units is reversed.

  • Create a new presentation



  • create filter for your presentation

    The target class is set to "Room" for applying presentations to rooms. Following the perspective RU, we will examine Rental Units connected to those rooms, and due to the reversed link in the perspective definition, data can be sent from rental units to presentation.

Now let's observe how this presentation appears in the drawing.
First, we locate the drawing connected to the floor. From this perspective, we can see that it has rooms (spots) connected to it.

Now we will apply presentation Room by RU

 

Filter legend panel option to select polygons when filtering values.

When applying a presentation, once one or more filters have been selected, the new button Select spots by filter will become active.

After it's clicked, all polygons that are part of this filter will be selected.

Selection is maintained when entering Edit mode, enabling editing operations to be performed.