Skip to main content
Version: 4.3

Views

Views allow presenting customized subsets of cards to users. They provide alternative representations of class or process data through filters, joins, SQL functions, or scheduler-based configurations.

Views can be defined in four ways:

  • Views from filter: subsets of cards belonging to the same class or process that satisfy a configured filter
  • Views from join: visual joins across multiple classes, with selectable attributes and filtering options
  • Views from SQL: result sets returned by a PostgreSQL function that aggregates data from multiple classes or processes
  • Views from scheduler: subsets of events that satisfy a configured filter

Filter-based and views from scheduler behave like standard card lists, while join-based and views from SQL are read-only.

Unlike permissions based on row filters, users can remove the filter applied to a filter-based view and display the complete content of the target class or process.

Views can also be defined on the Scheduling archive.

Views from filter​

This feature allows creating and managing views based on filters applied to classes.

Available operations:

  • add a new view
  • edit a view
  • delete a view
  • enable or disable a view

Each view requires the configuration of a set of metadata properties.

General Properties​

The following information is required:

  • Activity name
  • Description
  • Target class: the class or process on which the view is based
  • Active: enables or disables the view

Views

This form also includes icons for:

  • filter configuration
  • filter removal

Filters​

Filters are configured using the same mechanisms available in the Management Module.

Available operations:

  • select an attribute on which to apply the filter
  • select an operator, according to the attribute type
  • enter or select a value
  • delete a filter condition
  • apply the filter
  • remove the entire filter

A filter can contain multiple conditions.

Conditions defined on the same attribute are evaluated using OR logic, while conditions defined on different attributes are evaluated using AND logic.

Attributes

Permissions Tab​

This section allows configuring permissions on the current view for specific user groups.

Permissions determine which groups can access the view.

For details on permission management, refer to the related section.

Permissions tab

Views from join​

This feature allows creating and managing views based on joins across multiple classes.

General properties

Available operations:

  • add a new view
  • edit an existing view
  • delete a view
  • enable or disable a view

Properties Tab​

The configuration process is guided through a wizard.

Step 1 – General Properties​

The following fields are required:

  • Name: the unique identifier of the view
  • Description: the name displayed in the application. This field is localizable through the flag icon, which opens a dialog for entering translations in the enabled languages
  • Master class: the main class from which the relation traversal starts
  • Master class alias: alias assigned to the master class. By default, it matches the master class name
  • User permission: defines how user permissions affect the data returned by the view
    • Apply user permissions: data is filtered according to user permissions
    • Ignore user permissions: user permissions are ignored during query execution
  • Active: enables or disables the view

General properties

Contextual Menu​

A contextual menu can be configured using the same mechanisms available for class-level contextual menus.

General properties

Step 2 – Join Definition​

Joins are defined starting from the master class. For each linked class, it is possible to specify an alias and the join type (inner or outer).

Join Definition

Step 3 – Attribute Groups​

Fieldsets can be defined to group attributes from the joined classes.

Attribute Groups

Step 4 – Attribute Selection​

Select the attributes to expose in the view.

Attribute Selection

Step 5 – Attribute Customization​

Configure the following properties for the selected attributes:

  • Description
  • Group
  • Show in grid
  • Show in reduced grid

Attributes Customization

Step 6 – Filters​

Filters can be added to restrict the data returned by the join-based view.

Attributes Customization

Step 7 – Data Organization​

Define sorting and grouping rules for the view data.

Attributes Customization

Layout Tab​

A custom layout can be defined for views from join by specifying rows, columns, and attribute placement.

Layout Tab

Permissions Tab​

This section allows configuring permissions on the current view for specific user groups.

Permissions determine which groups can access the view.

For details on permission management, refer to the related section.

Views from SQL​

This section allows creating and managing views based on SQL functions.

SQL Views

Available operations:

  • create a new SQL-based view
  • edit a view
  • delete a view
  • enable or disable a view

General Properties​

The following fields are required:

  • Name: the unique identifier of the view
  • Description: the name displayed in the application. This field is localizable through the flag icon, which opens a dialog for entering translations in the enabled languages
  • SQL function: the function used to retrieve data
  • Menu icon: icon assigned to the corresponding menu item
  • Active: enables or disables the view

General Properties

PostgreSQL Function Requirements​

The SQL function must:

  • include the comment TYPE: function
  • explicitly define all input and output parameters
  • use supported PostgreSQL data types
  • define RETURNS SETOF record for multi-row output

After modifying a function, clear the CMDBuild cache or restart Tomcat.

Permissions Tab​

This section allows configuring permissions on the current view for specific user groups.

Permissions determine which groups can access the view.

For details on permission management, refer to the related section.

Views from scheduler​

This feature allows creating and managing views on the Scheduling archive.

The configuration process is similar to that of views from filter, except that the target data source is the Scheduling archive.

Views from Scheduler