Display User-Defined Fields in Group Structure and Visualisation
Administrators can include user-defined fields to be displayed when a group structure is generated and visualised.
By completing the steps that follow, you include the user-defined field in filtering, grouping, and sorting as well as in conditional formatting and sub-charting in Group Structure Visualisation.
-
Create the user-defined field you want to use and populate it in entity records.
To learn how to create user-defined fields, refer to Create User-Defined Fields. Note down the quick reference and the description of the user-defined field.
In this example, the VAT identification number user-defined field is created for UK companies and is populated in the company records.
-
Go to System Tools > List Manager.
-
In List Manager, find and select Group Structure Formatting.
-
On the Group Structure Formatting page, select New to open the Group Structure Formatting wizard.
-
On the Item Details page of the wizard, enter the quick reference and the description of the user-defined field you created in step 1, then select Finish.
The user-defined field is added to the Group Structure Formatting list.
-
Select the Show Rules
option for the item you just added. -
On the rules page, select New.
The Group Structure Formatting Rule wizard displays.
- On the Item Details page of the wizard, enter a description, leave 1 selected as the rule level and select Set value of custom value for Action. Select Next.
The rule level dictates the order of the rules you create.
- On the Expressions page, enter the quick reference of the user-defined field prefixed with UDF_ as Rule Expression. Select Next.
In this example, UDF_VAT is entered. You can also combine multiple user-defined fields using the operators at the bottom. For example, you can enter UDF_VAT && UDF_TAXTYPE which means the rule is applied if the entity has a value in both of these user-defined fields.
-
On the Custom Value Options page, select a Value, provide a Format string and select Finish.
The number you select in the Value field determines which custom field the rule is mapped to in Group Structure. In this example, 1 is selected, so Custom 1 holds the rule in the group structure settings.
In the Format String field, enter the rule expression you provided in the previous step between two percentage signs in order to add the user-defined field to the custom field you selected in the Value field. You can also add more text as required. In this example, %UDF_VAT% is entered in the Format String field.
If you want to combine multiple user-defined fields, enter each between percentage signs and prefixed with UDF_ and add any text in between them as required. For example, enter %UDF_VAT% and %UDF_TAXTYPE%.
-
Open the company record and go to Group > Additional Data.
-
Select the rule set you just set up in the Format Rules menu.
- Go to the Display tab and select Formatting Rule.
-
Add the user-defined field as a column to be displayed.
In this example, the rule was mapped to Custom 1, so Custom 1 needs to be added as a displayed column.
- Run the group structure, then visualise it.
The user-defined field you just added displays in the tree in Group Structure and it is available in filtering, grouping, sorting, conditional formatting, sub-charting and also as an attribute in Group Structure Visualisation.
See also
Filter the visualised group structure
Group Entities in the Visualised Group Structure
Sort Entities in the Visualised Group Structure
Set Details to Display in Entity Boxes
Create conditional formatting rules for entities
