1. Calculation functions
  2. All functions

Use functions to perform calculations with your data, change the format of your data, and more.

Some functions have differences in functionality, or are not available, in Polaris.

Title Description Category
ABS

The ABS function returns the absolute value of a number. The absolute value of zero or a positive number remains the same. The absolute value of a negative number is the same number without the negative sign (the positive version).

Numeric Functions
ADDMONTHS

The ADDMONTHS function adds a number of months to a date.

Time and Date Functions
ADDYEARS

The ADDYEARS function adds a number of years to a date.

Time and Date Functions
AGENTS

The AGENTS function calculates the number of servers (or agents) needed to fulfil requests within a target time.

Call Center Planning Functions
AGENTSB

The AGENTSB function calculates the number of servers required to answer a specified percentage of calls (or SLA) within a busy period.

Call Center Planning Functions
ALL

The ALL aggregation function returns a TRUE result for all values that match specific Boolean criteria in a source module.

Aggregation Functions
ANSWERTIME

The ANSWERTIME function calculates the minimum hold time required to answer a certain percentage of calls, or service level agreement (SLA).

Call Center Planning Functions
ANY

The ANY aggregation function returns a TRUE result for any value that matches specific Boolean criteria in a source module.

Aggregation Functions
ARRIVALRATE

The ARRIVALRATE function calculates the maximum interval between requests possible while processing a specified percentage of these requests.

Call Center Planning Functions
AVERAGE

The AVERAGE aggregation function takes a set of values from a source module and returns the mean average in a result module.

Aggregation Functions
AVGDURATION

The AVGDURATION function calculates the required average duration of calls in order to answer a certain percentage of calls, or service level agreement (SLA).

Call Center Planning Functions
AVGWAIT

The AVGWAIT function calculates the average waiting time for a request or call to be processed.

Call Center Planning Functions
CODE

The CODE function returns a list item's code.

Miscellaneous Functions
COLLECT

Use the COLLECT function in a module that includes a line item subset to pull the source line item values into the module.

Miscellaneous Functions
COMPARE

The COMPARE function compares text values. If they're the same, it returns 0. If the first text value is greater, it returns 1, and if the first text value is less, it returns -1.

Logical Functions
COUPDAYBS

Use the COUPDAYBS (coupon days before settlement) function to calculate the number of days from the beginning of the coupon period until its settlement date. The number returned includes both the first day of the period and the settlement date.

Financial Functions
COUPDAYS

Use the COUPDAYS function to return the number of coupon days in the coupon period that contains the settlement date.

Financial Functions
COUPDAYSNC

Use the COUPDAYSNC function to calculate the number of coupon days from the settlement date until the next coupon date. The number returned excludes the settlement date and includes the last day of the next coupon period.

Financial Functions
COUPNCD

The COUPNCD function calculates the next coupon date after a settlement date.

Financial Functions
COUPNUM

The COUPNUM function returns the number of coupons payable between a settlement and maturity date.

Financial Functions
COUPPCD

The COUPPCD function calculates the previous coupon date before a settlement date.

Financial Functions
CUMIPMT

The CUMIPMT function calculates the cumulative interest paid on a loan over a period given equal payments made to the balance.

Financial Functions
CUMPRINC

The CUMPRINC function calculates the amount of principal paid on a loan over a period, given consistent, equal payments.

Financial Functions
CUMULATE

The function CUMULATE adds values and returns a number. By default, the values are added across a time period. You can also choose to add values across a list.

Time and Date Functions
CURRENTPERIODEND

The CURRENTPERIODEND function returns the end date from a model's current period.

Time and Date Functions
CURRENTPERIODSTART

The CURRENTPERIODSTART function returns the start date from a model's current period.

Time and Date Functions
CURRENTVERSION

The CURRENTVERSION function returns the value from another line item for the version that is set as Current in a model.

Miscellaneous Functions
DATE

The DATE function forms a date from values that represent the year, month, and day. 

Time and Date Functions
DAY

The DAY function returns the day from a date as a number between 1 and 31. If the day is blank, it returns 0.

Time and Date Functions
DAYS

The DAYS function returns the number of days in a given time period.

Time and Date Functions
DAYSINMONTH

The DAYSINMONTH function returns the number of days in a month you specify.

Time and Date Functions
DAYSINYEAR

The DAYSINYEAR function returns the number of days in a year you specify.

Time and Date Functions
DECUMULATE

The DECUMULATE function calculates the difference between the values of the current and previous periods.

Time and Date Functions
DIVIDE

Use DIVIDE to divide one number by another.

Numeric Functions
DURATION

You can use the DURATION function to calculate the Macauley duration for an assumed parity value of 100 monetary units.

The Macauley duration is the weighted average maturity of cash flows. That is, the weighted average distance to payment. It's used to measure a bond price's response to changes in yield. A higher Macauley duration value indicates a riskier investment.

Financial Functions
END

The END function returns the last date of a time period. 

Time and Date Functions
ERLANGB

The ERLANGB function determines the probability of a request being blocked given a specified number of servers, arrival rate of requests, and the average service duration.

Call Center Planning Functions
ERLANGC

The ERLANGC function determines the probability of a request being placed in a queue given a specified number of servers, arrival rate of requests, and the average duration to process requests.

Call Center Planning Functions
EXP

The EXP function raises the mathematical constant e, or Euler's number, to the power you specify.

Numeric Functions
FIND

The FIND function searches for the first occurrence of a text value within another one. If the text contains the specified characters, the function returns a number. This number indicates the position of the first occurrence of the text value searched for.

Text Functions
FINDITEM

The FINDITEM function searches for a text value within the names and codes of the items or time periods in a given list or Time respectively. If the FINDITEM function finds a match, it returns the corresponding list item or time period.

Miscellaneous Functions
FIRSTNONBLANK

The aggregation function FIRSTNONBLANK returns the first value of a line item found for a given list item or time period. 

Aggregation Functions
FIRSTNONZERO

The FIRSTNONZERO function searches through two or more numeric arguments and returns the first value that is not zero.

Numeric Functions
FV

The FV function calculates the future value of an investment. The future value is the lump sum or closing balance received at the end of an investment.

Financial Functions
HALFYEARTODATE

The HALFYEARTODATE function cumulates values from a single numeric parameter, over a half-year period. The HALFYEARTODATE cumulation starts at the Fiscal Year Start Month as selected in the Model Calendar, and resets every half-year.

Time and Date Functions
HALFYEARVALUE

The HALFYEARVALUE function references another line item and returns the half-yearly time summary in place of the detail value.

Time and Date Functions
IF THEN ELSE

Tests a Boolean argument and returns one of two results based on whether it is true or false.

Logical Functions
INPERIOD

The INPERIOD function returns a TRUE result for a date that falls under a time period or a module's Time dimension. It returns FALSE for all other dates.

Time and Date Functions
IPMT

The IPMT function calculates the amount of interest to be paid on a loan in a given payment period. The function assumes a consistent interest rate and payment timings in each period.

Financial Functions
IRR

The IRR function calculates the internal rate of return for a series of positive and negative transactions. It can be used either with all transactions over a timescale, or with specified transactions on certain dates.

Financial Functions
ISACTUALVERSION

The ISACTUALVERSION function returns a TRUE result for the version that is set as Actual in a model. It returns FALSE for all other versions.

Logical Functions
ISANCESTOR

The ISANCESTOR function takes two list or time period values. It returns a Boolean value of TRUE if the first is the ancestor of the second. An item is the ancestor of another if it is at a higher level of a list hierarchy.

Logical Functions
ISBLANK

The ISBLANK function returns true for values that are blank.

Logical Functions
ISCURRENTVERSION

The ISCURRENTVERSION function returns a TRUE result for the version that is set as Current in a model. It returns FALSE for all other versions.

Logical Functions
ISFIRSTOCCURRENCE

The ISFIRSTOCCURRENCE function returns a Boolean value of TRUE for the first occurrence of a value in a list dimension.

Logical Functions
ISNOTBLANK

The ISNOTBLANK function returns a Boolean result for values that are not blank.

Logical Functions
ITEM

When used with a list, the ITEM function returns the list item that applies to each cell. When used with Time, it returns the time period that applies to each cell.

Miscellaneous Functions
LAG

LAG returns a value from a period in the past. 

Time and Date Functions
LASTNONBLANK

The aggregation function LASTNONBLANK returns the last value of a line item found for a given list item or time period. 

Aggregation Functions
LEAD

LEAD returns a value from a period in the future. 

Time and Date Functions
LEFT

Extracts a string of characters from text, starting from the left.

Text Functions
LENGTH

The LENGTH (or LEN) function returns the number of characters in a text string.

Text Functions
LN

Use the natural logarithm (LN) to work out the length of time it takes to achieve a unit of growth.

LN returns the natural logarithm of a number, based on the constant e. This function is the inverse of the EXP function, which raises e to the nth power.

Numeric Functions
LOG

The LOG function returns the logarithm of a number to the base you specify.

Numeric Functions
LOOKUP

Use the LOOKUP function to look up values in a source module or list and display the values in a target module. 

Logical Functions
LOWER

The LOWER function converts text values to lowercase.

Text Functions
MAILTO

Use the MAILTO function to generate clickable links that send an email. You can specify recipients, subjects, and body text.

Text Functions
MAKELINK

The MAKELINK function generates clickable links in a module.

Text Functions
MAX

The MAX aggregation function returns the maximum value from a line item in a source module.

Aggregation Functions
MAX

The MAX function returns the maximum from a set of values. For a number, it returns the maximum value. For a date, it returns the latest date.

Numeric Functions
MDURATION

You can use the MDURATION function to calculate the modified Macauley duration for an assumed parity value of 100 monetary units.

The modified Macauley duration expresses the measurable change in the value of a bond in response to a change in interest rates. The result represents the effect that a 1% change in interest rates will have on the price of a bond.

Financial Functions
MID

Extracts a number of characters from a text string, starting from a character you select.

Text Functions
MIN

The MIN aggregation function returns the minimum value from a line item in a source module.

Aggregation Functions
MIN

The MIN function returns the minimum from a set of values. For a number, it returns the minimum value. For a date, it returns the earliest date.

Numeric Functions
MOD

The MOD function returns the remainder when one number is divided by another, or modulo.

Numeric Functions
MONTH

The function MONTH converts a date or time period to a month in number format.

Time and Date Functions
MONTHTODATE

MONTHTODATE cumulates values from a single numeric parameter, within a monthly time range.

Time and Date Functions
MONTHVALUE

The MONTHVALUE function references another line item and returns the monthly time summary in place of the detail value.

Time and Date Functions
MOVINGSUM

MOVINGSUM returns values over a changing time range. For each time range included, it aggregates the sum of values found.

Time and Date Functions
MROUND

The MROUND function rounds a value to the nearest multiple of a number.

Numeric Functions
NAME

Use the NAME function to convert data from a list item to text.

Text Functions
NEXT

The NEXT function evaluates an expression based on the next period in the Time dimension.

Time and Date Functions
NEXTVERSION

The NEXTVERSION function evaluates the given expression using the next version.

Miscellaneous Functions
NPER

The NPER function calculates the required number of periods to achieve a certain value for a loan or investment. This is based on a given interest rate, consistent payments, and opening and closing balance.

Financial Functions
NPV

The NPV function calculates the net present value for a series of positive and negative transactions with a constant interest rate.

Financial Functions
OFFSET

OFFSET returns a value from a period before or after the current period. 

Time and Date Functions
PARENT

The PARENT function returns the parent item of list items and time periods.

Miscellaneous Functions
PERIOD

The PERIOD function converts a date to a time period. 

Time and Date Functions
PMT

The PMT function calculates the payments due for a loan or annuity over a specified number of periods, given a consistent interest rate and payment amount.

Financial Functions
POST

The POST function offsets, or posts, a numeric value into the past or the future by a given number of periods. If multiple values are offset to the same period, the POST function adds them together.

Time and Date Functions
POWER

The POWER function raises a number to the power you specify.

Numeric Functions
PPMT

The PPMT function calculates how much of a payment is allocated to its principal part rather than interest. The function assumes a consistent interest rate and payment timings in each period.

Financial Functions
PREVIOUS

The PREVIOUS function evaluates an expression based on the previous period of the Time dimension.

Time and Date Functions
PREVIOUSVERSION

The PREVIOUSVERSION function evaluates the given expression using the previous version.

Miscellaneous Functions
PRICE

The PRICE function calculates the price per 100 monetary units invested for a bond that pays periodic interest.

Financial Functions
PROFILE

Use the PROFILE function to multiply values over time based on a series of numbers, or profile.

Time and Date Functions
PV

The PV function calculates the present value of an investment or the principal value of a loan.

Financial Functions
QUARTERTODATE

QUARTERTODATE accumulates values from a single numeric parameter, within a quarterly time range.

Time and Date Functions
QUARTERVALUE

The QUARTERVALUE function references another line item and returns the quarterly time summary in place of the detail value.

Time and Date Functions
RANK

The RANK function evaluates a set of values and assigns sequential rankings starting at 1.

Miscellaneous Functions
RANKCUMULATE

The RANKCUMULATE function ranks values and then cumulates values in order of the ranking. It can perform ranking separately across different groups.

Miscellaneous Functions
RATE

The RATE function calculates the interest rate for a loan or investment based on length, payments, and present and future value.

Financial Functions
RIGHT

Extracts a string of characters from text, starting from the right. 

Text Functions
ROUND

The ROUND function rounds a value to a specified number of decimal places, an integer, or a power of 10.

Numeric Functions
SELECT

Use the SELECT function to return values from a given list item or time period.

Logical Functions
SIGN

The SIGN function returns the sign of a number (whether it's positive, negative, or zero). The SIGN function returns 1 for positive numbers, 0 for zero, and -1 for negative numbers.

Numeric Functions
SLA

The SLA function calculates what percentage of calls must be answered within a target answer time, or service level agreement (SLA).

Call Center Planning Functions
SPREAD

The SPREAD function divides a value evenly over a number of time periods. 

Time and Date Functions
SQRT

The SQRT function calculates the square root of a number.

Numeric Functions
START

The START function returns the first date of a time period. 

Time and Date Functions
SUBSTITUTE

The SUBSTITUTE function finds all occurrences of a text value within another one, and replaces them with a given value.

Text Functions
SUM

The SUM aggregation function sums values in a result module based on mapping from a source module.

Aggregation Functions
TEXT

The TEXT function converts numeric values to text.

Text Functions
TEXTLIST

The TEXTLIST aggregation function returns a collection of text values as a comma-separated value. The values returned are based on mapping from a source module.

Aggregation Functions
TEXTLIST

The TEXTLIST function concatenates a series of text values into a single text value.

Text Functions
TIMESUM

The TIMESUM function aggregates values between two time periods and returns a single value.

Time and Date Functions
TRIM

The TRIM function removes all leading and trailing spaces, and extra spaces between words in a text string.

Text Functions
UPPER

The UPPER function converts text values to uppercase.

Text Functions
VALUE

The VALUE function converts text values that represent numbers to numbers.

Miscellaneous Functions
WEEKDAY

The WEEKDAY function converts a date to a number between one and seven, representing the day of the week.

Time and Date Functions
WEEKTODATE

WEEKTODATE aggregates the daily values within a week from a single numeric parameter. WEEKTODATE resets after the last day of the week.

Time and Date Functions
WEEKVALUE

The WEEKVALUE function references another line item and returns the weekly time summary in place of the detail value.

Time and Date Functions
YEAR

The function YEAR converts a date or time period to a year in number format. 

Time and Date Functions
YEARFRAC

Use the YEARFRAC function to calculate the fraction of a year between two dates (inclusive of the start date, exclusive of the end date).

The function uses a basis (day-count convention) to count the number of days between these dates, and then divide that number by the basis.

Financial Functions
YEARTODATE

YEARTODATE cumulates values from a single numeric parameter, within a yearly time range. YEARTODATE resets at each yearly start date, based on Calendar Type.

Time and Date Functions
YEARVALUE

The YEARVALUE function references another line item and returns the yearly time summary in place of the detail value.

Time and Date Functions
YIELD

Use this function to calculate the yield to maturity (YTM) of a bond.

Financial Functions

Disclaimer

We may update our documentation occasionally, but will only do so in a way that does not negatively affect the features and functionality of the Anaplan service.