YSUM returns the Year-To-Date sum (total) of a specified variable, Cx, each day.

SYNTAX:

YSUM(Cx, optional Time Increment)
where :
Cx is a conditional variable x
Time Increment Optional - specifies the source variables (Cx) Frequency when the Source Variable (CX) and target variable's (i.e. the variable being calculated) frequencies do not match.

NOTES:

The variable to be summed must be specified as a Conditional Variable (use "C" instead of "V")

The result is stored based on target variables frequency:

• Daily - Stored every day.
• Daily Detail - The total thru the end of the day is stored in each slot.  Example, for an hourly calculation on Jan 2nd it will calculate the total thru the end of the second and store the same value for each hour of the second.  Therefore, it is HIGHLY recommended that the target variable (i.e. the one being calculated) is a daily variable. 

Care must be taken to keep this calculation up to date.  For example, if today were June 15th and for some reason you edited a value in the input variable, Cx, for February 14th; then you recalculated the month of June only.  The only values that have been updated to reflect the new value in February are those in June.  You must recalculate the variable containing this function from February 14th to the current date to update all values in between accordingly.

EXAMPLE 1: Return the Year-To-Date sum from a variable

Source variable (70) is set to Daily and Target variable (146) is also set to Daily. Because both the Source and Target variables are the same (Daily), the time increment BYDAY will be used.

V146 = YSUM(C70)

Variable 146 is the Year-To-Date sum of variable 70:

 

EXAMPLE 2: Return the Year-To-Date sum from an Hourly variable into a Daily Calculation.

Source variable (70) is set to Hourly and Target variable (146) is set to Daily.

V70 - Is a hourly parameter
V146 - Is a daily calculation

V146 = YSUM(V70,BYHOUR)

Note: You MUST specify the Time Increment (BYHOUR) that matches the source variables frequency (IE the source variable V70 is Hourly, therefore we specify BYHOUR) in order for the function to return the correct value.

See: Working with Daily Detail Variables in Calculations.