Introduction

Calculation Field allows you to perform a series of arithmetic computations to a set or a series of fields.

The Calculation Field is only available on Professional and Enterprise Edition.

Get Started

The easiest way to see how the Advanced Grid works is to use the existing built-in App Expenses Claims and look at an existing form in the app. Here are the steps:

  1. Start the Joget Server and open the App Center.

  2. Log in as admin and click on the pencil icon on the Expenses Claim to open the Design App. (see Figure 1)


    Figure 1

  3. Under Form Builder column, click on Expense Claim Form (see Figure 2)


    Figure 2

  4. Click on the Calculation Field labelled Total Amount $ on the canvas to open up the Configure Calculation Field properties.

  5. Take note of the Variables field. The spECD value is referring to another field within the form (see Figure 3).


    Figure 3

  6. Click on the Grid element to open the Edit Grid properties (see Figure 4).


    Figure 4

  7. In Figure 5, we are summing at a specific column from a Form Grid.

    Form Grid ID: spECD

    Column in Form Grid: amount

    Field ID to be filled in Figure 6: spECD.amount



    Figure 5


    Figure 6
  8. Click on Preview and enter values into the Amount column in the Grid to see the Total Amount $ automatically adds the values.

Calculation Field Properties

Edit Calculation Field

NameDescription
Label

Element Label to be displayed to end user.

ID

Element ID (By declaring as "total", a corresponding database table column "c_total" will be created)

Please see Form Element for more information about defining the ID and list of reserved IDs.

Variables
NameDescription
Variable Name

Declare a name to store the current row equation result.

  • subtotal
  • discountPercent
  • charges
Field ID

Form Field ID to retrieve.

If you are totalling a form grid column, use this format: formGridId.columnId where the first part before the decimal tells Joget which form grid to use and the second part after the decimal tells Joget which column is the specified form grid to use for calculation.

Multivalue Operation
  • Sum
  • Avg
  • Min
  • Max
Equation

Arithmetic operation using the variables declared above.

  • subtotal - (subtotal * discountPercent / 100)
  • subtotal - discountAmount
  • subtotal - charges (Correct)
  • subtotal-charges (Wrong)
  • It is essential to include spacing between operators.
  • The position and spacing of all elements of an equation must be exactly as they are to appear in printed form.


Advanced Options

Data & Validation

NameDescription
Validator

Attach a Form Validator plugin to validate the input value.

Validation will takes place whenever form is submitted except when it is submitted as "Save as Draft".

Format

NameDescription
Formatting Style
  • US Style Formatting (1,000.00)
  • European Formatting (1.000,00)
Number of DecimalNumber of Decimal
PrefixThe prefix of the calculated value
PostfixPostfix of the calculated value
Use Thousand Separator?Thousand Separator toggle.
Store as Numeric Value?

Toggle to store as a numeric value instead of a string


UI

NameDescription
Hidden?Shows this element to the end user.
Display as Label?Displays the value of the element as plain text.


Workflow

NameDescription
Workflow Variable

If the form is part of a workflow process, upon saving the form (by clicking on the "Save as Draft" or "Save" button). The value in this input field will be saved into the corresponding workflow variable named here.

You will get the following warning with the name printed out (e.g. status) in the server log if you attempt to map to a non-existent Workflow Variable.

context attribute status does not exist in process context - adding new attributes to the process context is not allowed