The HALFYEARVALUE function references another line item and returns the half-yearly time summary in place of the detail value.
For example, you can use the HALFYEARVALUE function to identify monthly sales that fell below average in the first half of a year.
|Number, Boolean, date, time period, list, text
|The line item to reference the half-yearly time summary value for.
The HALFYEARVALUE function returns a result of the same data type as the line item you reference.
- If you do not select Half-Year Totals in Time in the model settings bar, the HALFYEARVALUE function returns the line item's default value. For example,
0for numeric line items.
- The line item that contains the HALFYEARVALUE function must have a time scale of Day, Month, Quarter, or Year.
- You cannot use the HALFYEARVALUE function in a model that has the Calendar Type set to Weeks: General.
In Polaris, you must enable Half-year Totals in the Model Calendar to use the HALFYEARVALUE function. In the Classic engine, you can use the HALFYEARVALUE function regardless of if Half-year Totals is enabled in the Model Calendar.
In Polaris, you cannot use the HALFYEARVALUE function in a result line item with a time scale greater than the function. The Classic Engine returns a value of 0 in this case.
In this example, an Income Statement module has line items on rows and Time on columns. The Cost of Goods line item has a numeric data type, and the Month below average for half year line item has a Boolean data type.
In this example, in the Summary column for Cost of Goods, Time Summary is set to Average. The formula returns a TRUE result for values that are below average for each month in the first half of the year.
|Cost of Goods
Month below average for half year