Calculation User Field

Calculation User Field

This user field allows you to perform simple calculations based on the user fields on a list control. 

Supported user fields are

  • Currency

  • Number

  • Select

  • Radio

  • Checkbox

  • Cascading

The calculation user field only supports user fields added to a list control.

Configure the Calculation User Field

  1. Add a calculation user field to your form i.e. one of those listed above in NOTE.

  2. Go to the Calculation tab.

  3. Choose user field location. i.e. the user fields that you will be using for the calculation.

  • Aggregate (in a list table)

  • Outside of a list (not in a list table)

  • Per row calculations (this will automatically select if the calculation user field is in a list table) (refer here for more information)

image-20241213-005845.png

Aggregate (In a List Table)

  1. When Aggregate is chosen you must then select the list control (i.e. which list table the user fields you want to calculate are in).

Remember that a form can have more than one list control i.e. more than one list table.  You will need to pick the relevant list control to access the user fields to use them in calculations.

image-20241213-032606.png
  1. Pick the user field you wish to run calculations on.

  1. Select the value (operator) applicable to the user field type you have selected.

The choice of operators vary depending on the chosen user field type. Refer here for operators available for each user field type.

  1. Select the option.

If you have chosen a currency or number user field you will only have the option to add a number

If you have chosen a select, cascading, checkbox or radio button, the options that are available for that user field are displayed. Choose the one you want.

  1. Add a Condition. Refer here for more information regarding additional conditions.

  1. If you have chosen a CheckBox, RadioButton, Select or Cascading user field you will get Select the display style you wish to show for the result of this calculation.

  2. Choose how you want your calculation to display the results.

  1. Choose whether you want a number or currency 1000s separator and / or decimal places in your results.

  1. Refer here for Conditional Formatting.

  1. Click Save.

Calculation of More Than One Condition

RIB CX offers calculation of multiple criteria

Multiple Criteria Support:

Users can add one or more user fields and set multiple criteria within the calculation configuration.

  1. To add more criteria click 'Add Condition'. A new row will form with AND beside it. 

  2. Add the next conditions next to the AND row. This will be the second row of criteria for the calculation. 

  3. Click Add Condition again to add another row of criteria. 

Supported Calculations for Different User Fields

Below is a list of supported user fields and their applicable Operator (Value) and Display types.   Underneath each user field is a table detailing:

  • the applicable Operator (Value) for each user field type

  • the applicable Display As types for each condition.

Number / Currency User Fields

Operator (Value)

Description

Display as 

Operator (Value)

Description

Display as 

Any

Checks all rows with any value (including empty)

Count, Sum, Average

Not Empty

Checks for rows that are not empty in the list

Count, Percentage, Average, Sum

Empty

Checks for empty rows in the list

Count, Percentage

Equals

Checks all rows for a value equal to what is configured

Count, Percentage, Average, Sum

Not Equals

Checks all rows for a value that is not equal to what is configured

Count, Percentage, Average, Sum

Greater than

Checks all rows for a value greater than what is configured

Count, Percentage, Average, Sum

Greater than or Equal to

Checks all rows for a value greater than or equal to what is configured

Count, Percentage, Average, Sum

Less than

Checks all rows for a value less than what is configured

Count, Percentage, Average, Sum

Less than or equal to

Checks all rows for a value less than or equal to what is configured

Count, Percentage, Average, Sum

Select / Radio / Checkbox / Cascading

Operator (Value)

Description

Display as 

Operator (Value)

Description

Display as 

Any

Checks all rows with any value (including empty)

Count

Not Empty

Checks for rows that are not empty in the list

Count, Percentage

Empty

Checks for empty rows in the list

Count, Percentage

Equals

Checks all rows for a value equal to what is configured

Count, Percentage

Not Equals

Checks all rows for a value that is not equal to what is configured

Count, Percentage

Contains

Checks all rows that contain the value that is configured

Count, Percentage

Not Contains

Checks all rows that does not contain the value that is configured

Count, Percentage

Example

Outside of a List

You can use any number or currency user field on a form for calculation configurations.

  1. Choose Outside a List in the User Field Location option.

  2. Choose your calculation type

  1. Select the user fields you want to calculate.

  1. Choose how you want your calculation results to be displayed.

  1. Choose whether you want a number or currency 1000s separator and / or decimal places in your results.

  1. Refer here for Conditional Formatting.

  1. Click Save. 

Per Row Calculations for List Tables

You can add a calculation user field to a list table to perform per-row calculations.

One of the key benefits of this feature is the ability to configure simple calculations using multiple fields in the list, with the option to display the results as numbers, currency, or percentages. Whether you need to calculate costs, timelines, or other project metrics, this powerful capability will save you time and effort, while ensuring accuracy and consistency.

  1. The User Field Location and the List Control are preselected. This is because the calculation user field has been placed in a list table (tbl001).

  1. Choose your calculation type. Refer here for more information regarding the Date Calculation function.

  1. Select the user fields you want to calculate.

  1. Choose how you want your calculation results to be displayed.

  1. Choose whether you want a number or currency 1000s separator and / or decimal places in your results.

  1. Refer here for Conditional Formatting for Numbers and Currency Calculations.

  1. Click Save. 

Calculation - Re-Calculate Existing Forms

When the configuration of a calculation field is updated, it will automatically update all forms using that calculation field with the new value based on the new configuration.

Calculation Field Visibility

In order for a user field to be considered as part of a calculation, the user fields must be visible to the logged in user.

In addition, the current logged in user must have edit rights for the calculation user field.

Real-Time Calculations

Calculations Based on Date User Fields

To enhance form based automation, calculations can also be performed with date user fields. This reduces time and effort to calculate the period between two dates as an example. 

We support these types of calculations

 

Calculation

Result Displays as

Explanation

1

Date Field + Number field

Displays as a date

Adds number of days based on the value in the number field to the value in the date field

Eg

1-April-24 + 10 = 11-April-24

2

Date Field - Date Field

Displays as a number

Finds the day difference as a number between 2 dates

3

Date Field + Select field (based on code)

Displays as a date

Add number of days, months based on the code of the select field. As explained here

4

Date Field - Select field (based on code)

Displays as a date

Subtracts number of days, months based on the code of a select field.

5

Due date, Issued Date, Modified Date, Date First Closed, Date First Open, Date First Opened

+

Select field (based on code)

Displays as a date

Same as row 3

Calculations using standard fields do not support setting time values.

6

Due date, Issued Date, Modified Date, Date First Closed, Date First Open, Date First Opened

-

Select field (based on code)

Displays as a date

Same as row 4

Calculations using standard fields do not support setting time values.

Click here for information on how to create Document Triggers.

How to Configure Date Field + Number Field Calculation

  1. Create a Date user field (Date 01) and Number user field (Number 01)

  2. Create a Calculation user field (Date 1 + Number)

  1. Configure the Calculation user field to say Date 01 + Number 01

How to Configure Date Field + Select User Field Calculation

Similarly here is an example where Calculation is using date user field + a select user field 

Where Date 01 is a date user field and "Due In" is select user field with D and M codes as shown below :

Conditional Formatting for Numeric Calculations

Conditional Formatting for Numeric Calculations is a powerful enhancement that allows users to apply dynamic formatting to calculation fields displaying numerical, currency, or percentage results.

With this feature, users can easily configure conditional formatting by toggling a switch and defining rules based on specific conditions. Whether highlighting values above a certain threshold or emphasising deviations from expected ranges, users have full control over the visual presentation of calculation results

How to do I do it ?

After configuring your calculation field :

  1. Enable conditional formatting by toggling the switch and then add your rules for conditional formatting as shown below.

  1. Then we drop down menu to define how result should be displayed.

  • Results only - will just show the result (e.g. numeric value) without displaying the description / label

  • Results and Label - will show the result and description label

  1. This is where we define rules of when result should be displayed :

  • Equals, will display the calculated result when calculated value is equal to the number you define here

  • Greater than, will display the calculated result when calculated value is greater to the number you define here

  • Greater than or equal to, will display the calculated result when calculated value is greater than or equal to the number you define here

  • Less than, will display the calculated result when calculated value is less than to the number you define here

  • Less than or equal to, will display the calculated result when calculated value is less than or equal to the number you define here

  • Between, will display the calculated result when calculated value is between to the number you define here

When you have all numeric values linked to colours and labels, it should look something like this :

As a user: You will notice that when you enter numeric data, you will see it with it's allocated colour and label

This has many use cases. One of them is used in Category user field