Choose where you’d like to start

Sum

Note:

  • This task is applicable only to Zoho Creator.

Overview

The sum function in the "aggregate records" deluge task returns the sum of all values of a specified field from records fetched using a criteria.

The criteria is mandatory.

This function can be applied to the following field types:

  • Number
  • Percent
  • Currency
  • Decimal
  • Formula (numeric)

Return

Based on the specified field, the data-type of the returned value could be one of the following:

  • If the specified field type is Number, or Formula(bigint), the data type of the return value will be number.
  • If the specified field type is Percent, Currency, Decimal, or Formula(decimal), the data type of the return value will be decimal.

Syntax

<variable> = <form_link_name> [<criteria>].sum(<field_link_name>);

ParameterDescription
<variable>Variable which will hold the returned value.
<form_link_name>

Link name of the form from which the records will be fetched.

<criteria>

Criteria based on which the records will be fetched.

sum(<field_link_name>)

Link name of the field to which the sum function will be applied.

The "sum" aggregate function can be applied to the following field types:

  • Number
  • Percent
  • Currency
  • Decimal
  • Formula (numeric)

Things to keep in mind

  • If you wish to fetch all records of the specified form, use the following script as criteria:
    [ID != 0]

    It is advisable to fetch all records only when absolutely needed. Fetching all records generates a load resulting in performance issues.

This task can be used in the following events

When a record is Created
On LoadYes
On ValidateYes
On SuccessYes
On User inputYes
Subform on add rowYes
Subform on delete rowYes
When a record is Created or Edited
On LoadYes
On ValidateYes
On SuccessYes
On User inputYes
Subform on add rowYes
Subform on delete rowYes
When a record is Edited
On LoadYes
On ValidateYes
On SuccessYes
On User inputYes
Subform on add rowYes
Subform on delete rowYes
When a record is Deleted
On ValidateYes
On SuccessYes
Other workflow events
On a scheduled dateYes
During approval processYes
During payment processYes
In a Custom FunctionYes
In an Action item in reportYes

Example

The following script returns the sum of values of "amount" field from the fetched records.

EmployeeDetails = Employees [ ID != 0 ].sum(amount);

Get Started Now

Execute