Datagrid preferences overview
For the context of each overview specific datagrid preferences can be configured. Access to this level of configuration depends on permission on role level in client settings, Administration – Configuration – Client preferences, in the permission tree).
In the overviews, the Edit (2) button (in the subcategory List: Users) is available in the Preferences (1) tab. With the Reload (3) button. the setting for the data grid can be reloaded.
A datagrid preferences overview shows a list (1) with all relevant datagrid preference definitions within access of the current session.
►NOTE◄ The relevant content of this list depends on Context (5) (here: the context of a users overview) if opened from another overview, as explained above. In contrast, if the datagrid preferences overview is opened via the menu (Administration/Configuration/Client preferences), all datagrid preferences for any context are shown if accessible for the current session. Only in this case, does the Context field allow editing.
Clicking New (2) in the ribbon creates a new datagrid preference definition for a given context (if any, see note).
The Name (4) field is required and should be unique for a given context.
Once a datagrid preference definition has been created (i.e. saved for the first time), it is necessary to Assign (3) association criteria (see Association criteria).
Common settings
With the option Footer visible checked, the overview features a footer area, where the result of Footer operations are indicated if configured per column. In the screenshot below, an average is calculated for the Boolean column 'Active'. The value of 1.00 confirms that 100% of the users listed on the page are active.
The setting Lines/page defines how many rows are loaded per page. In the screenshot below, the default of 20 is active (see bottom left), yet only 6 rows (see bottom right) match the filter criteria.
The option Disable counting can be unchecked to prevent automatic updating for the total number of rows (see '... of 6' at bottom right in screenshot above) in an overview. This may improve performance for searches with extremely large result sets.
►NOTE◄ When this option is unchecked, the indicator shows '... of ?' to signal the count is disabled. A small update icon appears next to the text, as a trigger for counting on demand. The result of a manual update replaces the '?' and is prefixed by an approximation symbol ('≈').
... 
Column configuration
The Columns (1) tab features column definitions for the datagrid.
The list (2) shows all columns configured for the datagrid. The order of columns can be adjusted by dragging & dropping (3) the rows in the list.
Adding and removing columns
Clicking the Add column (1) button opens a search field (2), which allows a search of one of the available columns (3).
The trashcan (4) symbol can be used to remove column configurations from the datagrid.
Besides the columns automatically provided for a specific context, the first option in the search field, labelled Custom column, can be used to introduce custom columns into a datagrid, without an independent data source from the context.
Please refer to the Custom columns in data grids section for details. Most of column settings described in the following are applicable for custom columns as well.
Column configuration
Common settings
The Data field for a column is predefined and read-only by definition.
The setting for Width defines the default column width, which is applicable until a user applies an individual setting for the column. As soon as a user changes the column width in the datagrid of an overview, that setting overrides the configuration setting.
The Visible option controls whether a column is visible in the datagrid by default. Again, this setting can be overruled by individual user decisions.
►NOTE◄ Visibility settings per column do not influence the scope of the search, which always queries all configured content from the database. To improve the performance of updates, unnecessary columns should be removed completely from the datagrid definition.
Clicking the menu symbol (to the right of the Header label) opens a dialog for editing the localization data (see Localization).
Formatting
The Text alignment can be set individually for the column content and Header text alignment with the following choices: Left aligned, Centered, Right aligned.
Word wrap can be set individually for column content and Header word wrap with the following options:
|
Word wrap option |
Effect |
Example |
Explanation |
|
None |
No word wrapping; excess text is replaced by '...' |
|
Header and content are cut off with '...' indicating hidden text. |
|
Only on line break characters |
Line breaks at line break characters (CR/CRLF); excess text is replaced by '...' |
|
Header is cut off (no line break) and content shows two lines (separated by a CRLF character), both cut off by '...'. |
|
Auto |
Automatic line breaks on space or line break characters (HTML browser functionality) |
|
Header and content wrapped automatically at space and line breaks. |
A setting for Number of digits only applies for columns with numeric content.
Label helper configuration
For certain columns, containing references to other objects, the Formatting section features a button Label helper configuration. This button opens a view similar to the service configuration of an Combobox for the columns field, which defines from what content a 'label' for the list column and related filters should be built, to enable the user to identify available choices.
Filter and sorting
The option Default sort ASC indicates, if the default sort order for the column should be ascending (checked) or descending (unchecked).
The dropdown for Default sort order allows the definition of the sort hierarchy level (ascending integers: 0, 1, 2, ...) for the column, where 0 is the highest level. Without an indication of level, the column is not considered by sorting.
The settings for Default filter value are evaluated against the database to restrict search results in the grid when an overview is opened.
These choices or setting for filters may vary per column depending on data type (plain text, numerical values, dropdowns for enumerations, date ranges for date attributes, etc.). Filter criteria defined per column are visible in the datagrid at runtime and can be changed or removed by the user.
►NOTE◄ Unlike filter criteria per column of a datagrid Restrictions defined for an overview (see Custom overviews) are not visible when the overview is opened and cannot be reset or edited by the user.
Specific settings for date columns
The following special settings and filters are featured for date columns.
The default filter value provides a number of specific presets for date range criteria:
Selecting Custom... from this list opens a small dialog, where a custom time window can be defined by selecting dates for the From and To calendar elements:
►NOTE◄ The option Immediate search has no effect on datagrid definitions. It is relevant in interactive context and controls if search results should be automatically refreshed after one of the dates is changed.
The following specific settings appear, when a Date/Time column is selected:
Date/Time format can be defined by a string using the Java notation, e.g. 'dd.MM.yyyy'. The format pattern is applied to both values if the column indicates date range values ('10/16/2018 – 10/18/2018').
Footer cell
For each column a Footer operation for the Footer cell can be selected from the following choices:
Sum (the total of all values in the column)
Minimum (the lowest value of the column)
Maximum (the highest value of the column)
Average (the average of all values in the column)
►NOTE◄
Footer operations calculate results per page (and not the entire search results), so by default only 20 rows are considered.
Numeric attributes are evaluated with consideration on units. Results are represented in the dominant unit, which is determined by its frequency within the current page.
Footer operation results are only displayed if the option Footer visible is checked for the data grid (see above).
For numeric columns Footer operation precision can be defined, to control the number of decimals for the result per column.
Projection, Restriction projection and Join
Typically these settings are provided automatically and do not require maintenance.
Row formatter
Conditional row formatting is explained in Row formatting in datagrids.