Label*

Default Value: Aggregate
Example: Aggregate_Avg

String

Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline.

Aggregate fields*

Use this field set to define the type of Aggregate function to perform on the field and the key name to be used in the output. This field set contains the following fields:

• Function

• Field

• Result field

Function*

Default Value: SUM
Example: AVG

String

Select the functions that applies to the aggregate field value in the input data. The available functions and the supported datatypes are: 

• COUNT – all types.

• SUM – Number (Numeric string is converted to a number).

• MIN – Number, String, DateTime, LocalDateTime, LocalDate, LocalTime.

• MAX – Number, String, DateTime, LocalDateTime, LocalDate, LocalTime.

  • When using MIN/MAX functions for Date, you should change “$DATE.date" to "$DATE" in the Aggregate field.

• AVG – Number, DateTime, LocalDateTime, LocalDate, LocalTime (Numeric string is converted to a number).

• CONCAT – Concatenates all records separated by a pipe (|).

• UNIQUE_CONCAT – Concatenates all unique records separated by a pipe (|).

Field*

Default value: [None]
Example:  $Total or DateTime.parse($service)

String/Expression

Specify a JSON path to the field on which the Aggregate function should be applied such as $items.item. Learn more: JSONPath - XPath for JSON.

Result field*

Default value:  [None]
Example:  Revenue

String

Specify the field name to be used for mapped data in the output. This value is the aggregate computed result corresponding to the GROUP-BY field values.

GROUP-BY fields*

Use this field set to define field paths and names. If you leave this field blank, the Snap produces only one output document. This field set contains the following fields:

• Field

• Output field

Field

Default value: [None]
Example:  $.Product.Name

String/Expression

Specify a JSON path for the GROUP-BY field.

Output field

Default value:  [None]
Example:  ProductName

String

Specify the GROUP-BY field name to be used in the output map data. If left blank, the Field path is used instead.

Checkbox

Select this checkbox if you want the Snap to produce integer results rounded half up.

Dropdown list

Select an option to specify if the input documents are sorted or not.

This option enables the Snap to verify if the input is sorted as it processes each document and performs the aggregation efficiently and displays an error if the records are not sorted.

The available options are:

• Unsorted: The input documents are not sorted. When not sorted, the Snap uses a memory-intensive method that tracks the value of the aggregation for every unique value of the GROUP-BY fields.

• Ascending: The input documents are sorted in an ascending order.

• Descending: The input documents are sorted in descending order.

Dropdown list

Select one of the three modes in which the Snap executes. Available options are:

• Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.

• Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.

• Disabled: Disables the Snap and all Snaps that are downstream from it.