Aggregate Functions

Aggregate Functions

Overview

These functions give you the ability to select a group of records from an arbitrary object and produce an aggregate value (SUM, COUNT, MAX, MIN, AVG), without having to write Java code.

Functionality

Methods	Field Types
SUM(object_id, object_field, criteria)	number, currency, boolean
AVG(object_id, object_field, criteria)	number, currency, boolean
MAXIMUM(object_id, object_field, criteria)	number, currency, date
MINIMUM(object_id, object_field, criteria)	number, currency, date
COUNT(object_id, criteria)	n/a

where:

• object_id - Object Name or Object Identifier
• object_field - Field in the specified object

Restriction: A Lookup field cannot be used.

• criteria: - A condition that specifies the object records that are part of the collection.

• Syntax is same as searchRecords() API of JAVA/REST criteria
  

The relevant information is here (only the page title is inappropriate): JAVA_API:Filter_Expressions_in_JAVA_APIs

• Criteria must contain at least one index field. If index is combination of fields, the criteria must contain first field in that index. (It does not need to be a unique index, but an index is required, for performance.)

Note: The maximum number indexes currently allowed in an index definition is 5.

Considerations

• The SUM() of a boolean field gives a count of values that are yes/true.
• The AVG() of a boolean field gives the percentage that are yes/true.

Note: The results doenot take into account user-security restrictions. These functions operate on the entire set of records in an Object, regardless of user capabilities.

Availability

The Aggregate Functions are available here:

• Validations
• Data Policies

• Criteria (Action Based - Add, Updae, Delete, Import Record, Ownership Change, Workflow State Change)
• Add/Update Record Action

• Calendar Data Policies - Criteria Not Support
• Calendar Data Policies - Add/Update Record Actions Aggregate functions will be evaluated.
• Default Values
• Formula Fields

They are not available here:

• Layout Rules
• Custom Access Criteria
• Reports