What are Rollup Fields?
Rollup fields allow you to have a field on a higher entity (such as an Order), that automatically sums a defined set of fields from a lower level (such as a Line Item). For example, I want a field for “Total Impressions” on the Order form, that is a sum of all the Impressions fields on each Line Item of the Order.
-
Rollup fields are read-only, and automatically sum any fields on the level below that set their Rollup Field Name to this target (unless they are start_date or end_date).
-
For Date Rollup fields, the value for start_date will imply the earliest, lower level start_date, and the value for end_date will imply the latest, lower level end_date.
Rollup Hierarchy
-
Clients
-
Order
-
Line Items
-
Flights
-
-
-
Rollup Field Rules
Rollup Fields are subject to the following rules:
-
Rollup sources cannot be calculated fields.
-
Rollup sources cannot have a parent field.
-
Rollup fields should not be set as required fields.
-
A field on a Task form cannot be a Rollup field.
-
For client-level Rollup fields:
-
the data types can be either string or integer.
-
if the Rollup source is decimal, currency, or percentage, then the client-level Rollup field’s data type should be a string so that that value can be displayed correctly.
-
-
For Order, Line Item, and Flight Rollup fields:
-
the data types can be percentage, currency, decimal, or integer.
-
for start_date and end_date Rollup fields, the data type must be a date.
-
Rollup Field Configuration
Non-date Rollup field configuration
1] Navigate to the form to which you’d like to add a Rollup field.
2] Click the plus icon to add a new field, or double-click on any existing field.
3] Update the Input Type to Rollup Target.
- This field will now appear for selection on the lower-level field configuration, as an option for Rollup Field Name.
4] Click OK.
5] Navigate to the form on the lower level where the field is that should be a contributor for the Rollup.
6] Click the plus icon to add a new field, or double-click on any existing field.
7] Scroll to the bottom of the field configuration pop-up and select the Rollup Target from the options in the Rollup Field Name.
| NOTE: Anything entered into the field on the lower level will roll up into the field on the upper level. |
Date Rollup configuration
9] Repeat steps 1 and 2 above.
10] Click the plus icon to add a new date field, or double-click on any existing date field.
11] Update the Input Type to Rollup Target.
| NOTE: Lower-level start_date and end_date fields are implied Rollup sources and cannot be configured. |
| NOTE: Values entered in the start_date and end_date fields on the lower level will roll up into the field start_date and end_date fields on the upper level. |
| NOTE: We currently do not support a “re-Rollup” of existing forms if it is modified to add a Rollup field. Newly added Rollup fields are applied on the forms when Rollup sources are next modified. |