Skip to content

Grouping Field

Data grouping can be done within a list or within an IFS Cloud records page. It allows for the dynamic presentation of columns based on user-defined filters, promoting a tailored and efficient display of relevant information.

Variations

Group Data

The Group Data slide-out menu encompasses all columns and data aggregation types defined within the marble syntax. End users have the capability to manually select or deselect checkboxes to add or remove data columns as needed.

Group Data

Context search checkboxes provide an option to simultaneously select multiple choices within "Group Data." Upon the end user's selection or deselection of checkboxes in the context search pane, a corresponding automatic selection or deselection of checkboxes within "Group Data" occurs. These modifications adhere to the configuration specified in the "Search Parameter Setting".

Search Parameter Settings:

The "Search Parameter Settings" enable you to specify how changes implemented in context search, filter search and group data should take effect to grouping fields .

search parameter settings

When criteria is changed: Implement modifications promptly upon the user's selection of options in the Filter Pane, Search Context Pane, or Group Data slide-out menu.

Only when Search button pressed: Selected changes within the Filter Pane, Search Context Pane, or Group Data slide-out menu are implemented upon pressing the "Apply" button.

When to Use

  • To define new grouping fields in group data.
  • To define new grouping fields in search context pane.

How to Use

1. Add Grouping Field Set To List

Sample Marble Syntax to define initial grouping.

groupingfieldset <Groupingfieldset_Definition> {
setgroupingstartup = [true];
initialgrouping = <Column_Name1> , <Column_Name2> , <Column_Name3>, <Column_Name4>;
}
1.1 Apply grouping on startup

Enable / Disable automatic list data population with initial data grouping criteria when the search criteria are not defined. Enabling this option will let you group all the data with additional grouping criteria from the start.

setgroupingstartup = [true];

Note:

true: Initial grouping is applied only when you click on "Apply" command in the search context pane after opening an IFS Cloud records page.

false: Initial grouping is applied when opening the page.

Only valid if you have any initialgrouping

1.2 Define initial grouping
initialgrouping = <Column_Name1> , <Column_Name2> , <Column_Name3>, <Column_Name4>;

Note:

  • Initial grouping can be done to the fields that does not have any selected expressions
  • Initial grouping can also include aggregated fields
2. Define Grouping Field Set

Marble Syntax to define which check boxes in "Group Data" slide out menu must be selected when selecting the predefined check boxes in Context Search.

groupingfieldset <Groupingfieldset_Definition> for <Search_Context_Checkbox_Definition>{

groupingfield <Column_Name1>{
    selected = [not searchcontext.ConsolSearchContext.NoGrouping];
}

groupingfield <Column_Name2>{
    selected = [not searchcontext.ConsolSearchContext.NoGrouping];
}

groupingfield <Column_Name3>{
    enabled = [false];
    selected = [true];
}
summary = DebitAmount, CreditAmount, BalaceAmount, CurrDebitAmount, CurrCreditAmount, CurrBalanceAmount;
}

Note: Context search selections and selections based on another grouping field will always override the initial grouping selections.

2.1 Grouping field

Marble syntax to specify which columns you want to include or exclude in "Group Data" slide-out menu. You can also define whether each column is enabled (active) and selected (visible).

groupingfield <Column_Name1>{
enabled = [false];
selected = [true];
}

2.1.1 selected

Allows you to provide the end user with the option to manually select or deselect a column using checkboxes in the "Group Data" slide-out menu .

groupingfield <Column_Name1>{
.....
selected = [true]; 
}

groupingfield <Column_Name1>{
    selected = [not searchcontext.ConsolSearchContext.NoGrouping];
}

Following syntax can be used in scenarios where you want to provide an end-user with the capability to select a grouping field, and once its selected another grouping field is automatically selected but cannot be changed manually.

groupingfield <Column_Name2>{
    selected = [<Column_Name1>];
    enabled  = [not <Column_Name1>];
}

2.1.2 enabled

Allows to configure whether the end user should be able to alter the selected value in the "Group Data" slide-out menu

groupingfield <Column_Name1>{
.....
enabled = [true]; 
}
2.2 Aggregated fields

Aggregated fields are the ones that included in summary which consists of certain number fields

summary = DebitAmount, CreditAmount, BalaceAmount, CurrDebitAmount, CurrCreditAmount, CurrBalanceAmount,

Limitations

None.

Keywords

None.

Properties

Below is a list of properties that can be used to customize the control.

groupingfieldset|setgroupingstartup|initialgrouping|groupingfield|summary

Example