Contact us Blog

JavaScript calculations in Apsona reports

Overview

This page is intended to provide a quick overview of JavaScript expressions, specifically in the context of the "calculated fields" functionality available in Apsona's single-step and multi-step reports. This overview is just for getting you started. Much more extensive resources available on the web include You don't know JS (a free e-book), the Mozilla Developer Network and Eloquent JavaScript.

Calculated values are supported in Apsona's single-step reports as well as multi-step reports. A calculated value is simply a JavaScript expression which uses the columns of the report as variable names, and standard JavaScript operators and methods.

Variable syntax

For single-step reports, when using the value of a column in a report, the column name must surrounded by {! and } symbols. Note also that the column name must match exactly, including letter case, e.g., the column reference {!Total Amount} would be incorrect when referring to a column named Total amount because of case mismatch. Similarly, the column reference {!TotalAmount} would be incorrect because the lack of the single space.

With multi-step reports, to insert a variable referring to the value of an earlier step, you use the step name of the variable, followed by a period and then column name, surrounded by {! and } symbols. For example, if you have a query step named Opportunities containing a field named Amount, you use the notation {!Opportunities.Amount}. You can use the "Insert reference to field" dropdown in the field editor as a quick way to insert these variables into your formula.

Thus, a calculation step with a field containing the formula {!Opportunities.Amount} * 0.075 calculates a 7.5% commission on the amount. The effect of adding a calculation step is to add new columns to the report in which each row contains the result of applying the formulas of the step to the other columns in the row.

Data types

Each variable used in a calculation formula denotes a value from an earlier query step in the report. So, the variable will have the data type of the column of that value. In the above example, the variable {!Opportunities.Amount} is of type currency (a numeric value). So it makes sense to multiply it by 0.075. By contrast, of you had a variable {!Opportunity.Close Date} containing the close date of the Opportunity, its value would have the data type Date, so you can use any JavaScript Date operations on that value. For example, you can write a formula {!Opportunity.Close Date}.getFullYear() that uses the getFullYear method of JavaScript's Date object to obtain the year of that date.

Examples

JavaScript expressions are very powerful and flexible. You can find detailed documentation about them in many places on the web, in particular at the JavaScript area of the Mozilla Developer site. Here are a few examples.

Conditionals. This example shows how to use JavaScript's conditional ternary operator to calculate conditional (if-then-else) values in a formula. Given the opportunity amount field Oppties.Amount, the formula {!Oppties.Amount} * ({!Oppties.Amount} <= 10000 ? 0.075 : 0.085) calculates a commission of 7.5% on the amount if the amount is $10,000 or less, and 8.5% if the amount is over $10,000.

JavaScript functions. You can calculate the age of an Opportunity – the number of days from created date to close date – using the following formula: {!Oppties.Close Date}.daysAfter ({!Oppties.Created Date}) This formula uses the daysAfter method that is not part of native JavaScript, but is provided by Apsona. The daysAfter method is really just a convenient shortcut. You would get the same result using plain JavaScript's getTime method, which returns the number of milliseconds since Jan 1, 1970, and using the fact that there are 86,400 seconds in a day: Math.floor (({!Oppties.Close Date}.getTime() - {!Oppties.Created Date}.getTime()) / 86.4E6)

String splitting. JavaScript includes capabilities for easily splitting strings into pieces using regular expressions. For example, consider this common situation. Suppose you have a data field named Street Address in your report containing the street address part of a full Contact address, but this field actually contains multiple lines, as is often the case with international addresses. Suppose now that you want to produce each of the lines in that field in a separate field. You can achieve this goal using the regular-expression-based splitting that JavaScript supports. For example, to create a field named Street1 that contains the first line of a multi-line street address field named Street Address, you can use the following calculation:
        {!Street Address}.split(/\n/)[0]
This formula splits the string Street Address into parts returned in an array, and then extracts the first part by referring to the first element (element 0) of the array using the subscript notation. Similarly, the formula {!Street Address}.split(/\n/)[1] gives us the second line in the multi-line address.

Bucketing. You can get really fancy with writing in-line JavaScript functions. For example, given a previous step named Account that has a column named Billing State containing a state abbreviation such as CA or NV, the following formula returns the full name of the state for known abbreviations, and Unknown for an unknown abbreviation:
        (function (abbrev) {
            var nameMap = {"CA": "California", "NV": "Nevada", "OR": "Oregon"};
            return abbrev in nameMap ? nameMap[abbrev] : "Unknown";
        }) ({!Account.Billing State});
      

Another example involves bucketing a numeric value, such as the age of a person. If your buckets are uniformly distributed (e.g., 20-year intervals), you can use the following calculation:

        (function (ageValue) {
            var buckets = ["19 or younger", "20-39", "40-59", "60+"]; /* Set up the bucket names */
            var index = ageValue % 20; /* Find the bucket in which the given age range belongs */
            if (index <= 0) { /* Fix it up if it's out of range */
                index = 0;
            } else if (index >= 3) {
                index = 3;
            }
            return buckets[index]; /* Return the correct bucket name. */
        }) ({!Contact.Age});
      
But if your buckets are ad-hoc, you might want to use conditionals like this:
        (function (ageValue) {
            return ageValue < 18 ? "Under 18" :
                 ageValue <= 44 ? "18-44" :
                 ageValue <= 64  ? "45-64" : "65+";
        }) ({!Contact.Age});
      

Constraints

Some constraints to note:

Examples

Below are a few examples.

Calculation codeResult typeNotes
{!Total} >= 0 ? "Positive" : "Negative" String The result is string Positive if the value of the Total column is zero or more, and the string Negative otherwise. This is an example of a ternary or conditional expression
{!Total} + 335 Number or Currency The result of adding 335 to the column named Total. If the Total column is empty, the result will be NaN (the special JavaScript value called Not a Number)
(isNaN ({!Total}) ? 0 : {!Total}) + 335 Number or Currency The result is zero if the Total column is empty, and adds 335 to that column otherwise. This example builds on the one above, and uses the built-in isNaN function to ensure that the result is always a number regardless of whether or not the Total column is empty.
({!Total} || 0) + 335 Number or Currency The result is the same as in the above example, but the technique is different: it uses JavaScript's shortcut 'or' operator.
{!CloseDate}.getFullYear() < 2000 ?
"Last millennium" : "This millennium"
String Assuming that the CloseDate column is of type Date, this example uses the Date object's getFullYear method to obtain the year of the close date. So its result is a string that indicates the millennium of the close date.

Apsona enhancements

Apsona includes several methods that enhance the native JavaScript functionality, described below. These functions are available only in the Apsona pages, not natively in JavaScript.

Date methods

These methods are available on Date values, i.e., you can only use them on a column whose value is known to be of type Date.

FunctionResult typeExample
addDays (numberOfDays) Date {!CloseDate}.addDays (15)
Produces a new Date whose value is the given date plus the given number of days. The number of days can be positive or negative. Note that the result includes the time part as well. For example, if you add 5 days to March 12, 2016 1:20 pm your result will be March 17, 2016 1:20 pm. This method correctly accounts for leap years, transitions across months and years, and the like.
closestPreviousWeekday (wkDayNo) Date {!CloseDate}.closestPreviousWeekday (3)
The wkDayNo parameter must be a number between 0 and 6 (indicating Sunday through Saturday). In this example, the result is the previous Wednesday closest to the CloseDate column.
daysAfter (aDate) Date {!CloseDate}.daysAfter ({!StartDate})
Produces the number of days between the two dates. If the aDate parameter is before the specified date, the result is positive, otherwise negative. This example produces the number of days between the CloseDate and StartDate columns.
endOfDay() Date {!CloseDate}.endOfDay()
Produces the value of 11:59:59 pm on the given date. For example, for the date March 12, 2016 1:20 pm the result will be March 12, 2016 11:59:59 pm. Note the pair of parentheses after startOfDay - that's required by JavaScript syntax.
format (formatString) String {!CloseDate}.format ("yyyy-MM-dd")
The value of the CloseDate column, formatted like 2016-07-13. The format codes in the formatString parameter indicate the layout of the result. Note that format codes are case-sensitive.

Here are the format codes that Apsona recognizes:

yyyyFour digit year, e.g., 2017
M One- or two-digit month, e.g., 1 for January and 10 for October
MM Two-digit month with a leading zero if necessary, e.g., 01 for January and 10 for October
MMM Three-letter month name, e.g., Feb for February
MMMMFull month name, e.g., October
d One- or two-digit date
dd Two-digit date with a leading zero if necessary
EE Full weekday name, e.g., Monday
E Three-letter weekday name, e.g., Mon
HH Two-digit hour of day, in 24-hour format
hh Two-digit hour of day, in 12-hour format
h Hour of day in 12-hour format, with leading zero if needed
mm Two-digit minute of hour, with leading zero if needed
ss Two-digit seconds, with leading zero if needed
a AM/PM indicator

startOfDay() Date {!CloseDate}.startOfDay()
Removes the time part of the date, if any, and produces the value of midnight. For example, for the date March 12, 2016 1:20 pm the result will be March 12, 2016 12:00 am. Note the pair of parentheses after startOfDay - that's required by JavaScript syntax.

Number methods

These methods are available on Number values, i.e., you can only use them on a column whose value is known to be a number or currency.

FunctionResult typeExample
formatWithCommas () String {!Quantity}.formatWithCommas ()
Produces the number with commas in the thousands positions. For example, for the code (1300207).formatWithCommas() will produce 1,300,207.
formatAsCurrency (currencySymbol) String {!TotalAmount}.formatAsCurrency ("$")
Produces the number formatted as a currency value, with commas in the thousands positions. For example, the code (23457.89).formatAsCurrency() will produce $23,457.89.

Multi-pick methods

These methods are available on multi-pick values, i.e., you can only use them on a column whose value is known to be a multi-select picklist field.

FunctionResult typeExample
choices () Number {!Interests}.choices ()
Produces an array containing the values selected in the multi-select field.
allowedChoices () Number {!Interests}.allowedChoices ()
Produces an array containing all of the allowed values for the multi-select field.
As an example, suppose you have a field named {!Interests} that produces a multi-select picklist value, and you want to display its contents in English-like syntax. You could then use this calculation:
{!Interests} == null ? "" :
{!Interests}.choices().length <= 1 ? {!Interests} :
{!Interests}.choices().slice(0, {!Interests}.choices().length-1).join (", ") + " and " +
    {!Interests}.choices()[{!Interests}.choices().length-1]
      
This logic is set up so that if the selection contains only one value, it produces that value; otherwise, if there are n selected values, it produces the first n-1 values comma-separated, then an "and" and finally the last value, as expected in English, e.g., Red or Red and Blue or Red, Blue and Green - notice the placement of the commas and the word "and" in the right places.

Row functions

As noted above, if you create an expression that involves column references, it will only use the values of the referenced columns in the current row. But sometimes you would want to use data values from elsewhere in the report, e.g, a running sum, or a column total. The functions documented below are meant to serve such needs.
FunctionResult typeExample
columnTotal (columnName) Number columnTotal ('Commission $')
Produces the total value of the specified column across all the rows of the report. Obviously this makes sense only for columns with numerical values such as number or currency.
prevValue (columnName, rowOffset) prevValue ('Posted Date', 1)
Produces the value in the cell in the specified column, in the previous row offset from the current row by the specified amount. In the above example, we are obtaining the value in the column labeled Posted Date, in the row immediately before the current row. The data type of the produced value (number, date, etc.) is the same as the data type of the column specified.
rowCount () Number rowCount ()
Produces the number of rows in the report.
rowNo () Number rowNo ()
Produces the row number of the current row. Row numbers start at 0, not 1.
runningSum (columnName) Number runningSum ('Commission $')
Produces the running sum of the specified column, up to and including the current row. This function can be applied to any numerical columns, such as numbers or currencies.
value (columnName, rowIndex) value ('Posted Date', 4)
Produces the value in the cell in the specified column and row. In the above example, we are obtaining the value in the column labeled Posted Date, in row 4 (i.e., the fifth row, since rows are indexed from 0). Note that when calling this function, the column name must be enclosed in either single or double quotes. The data type of the produced value (number, date, etc.) is the same as the data type of the column specified.