All functions

ABS(Number)

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).

ADDMONTHS(Date, number)

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

ADDYEARS(Date, number)

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

AGENTS(SLA, Target response time, Arrival rate, Average duration)

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

AGENTSB(SLA, Arrival rate, Average duration)

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

Source[ALL: Mapping, ALL: Mapping 2, etc.]

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

ANSWERTIME(Number of servers, SLA, Arrival rate, Average duration)

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

Source[ANY: Mapping, ANY: Mapping 2, etc.]

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

ARRIVALRATE(Number of servers, SLA, Target response time, Average duration)

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

Values to average[AVERAGE: Mapping, AVERAGE: Mapping 2, etc.]

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

AVGDURATION(Number of servers, SLA, Target response time, Arrival rate)

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

AVGWAIT(Number of servers, Arrival rate, Average duration)

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

CODE(Item)

The CODE function returns a list item's code.

COLLECT()

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

COMPARE(Text to compare 1, Text to compare 2 [, Comparison mode] [, Locale])

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.

COUPDAYBS(Settlement, Maturity, Frequency[, Basis])

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.

COUPDAYS(Settlement, Maturity, Frequency[, basis])

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

COUPDAYSNC(Settlement, Maturity, Frequency[, basis])

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.

COUPNCD(Settlement, Maturity, Frequency)

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

COUPNUM(Settlement, Maturity, Frequency)

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

COUPPCD(Settlement, Maturity, Frequency)

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

CUMIPMT(Interest rate, Number of periods, Principal, Start period, End period [, Timing])

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

CUMPRINC(Interest rate, Number of periods, Loan balance, Start period, End period[, Timing])

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

CUMULATE (Values to add [, Boolean] [, List])

The CUMULATE function calculates the sum of a given set of values either over a time period or across a specified list. By default, it calculates the sum over a time dimension. You can also include a Boolean line item to determine which values should be included in the accumulation.

CURRENTPERIODEND()

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

CURRENTPERIODSTART()

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

CURRENTVERSION(Expression)

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

DATE(Year, Month, Day)

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

DAY(Date)

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

DAYS([Period])

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

DAYSINMONTH(Year, Month)

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

DAYINYEAR(Year)

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

DECUMULATE(Value to subtract [, List])

The DECUMULATE function subtracts the value of the previous item from the current over any dimension.

DIVIDE(Dividend, Divisor)

Use DIVIDE to divide one number by another.

DURATION(Settlement, Maturity, Rate, Yield, Frequency [, Basis])

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.

END([Time period]) 

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

ERLANGB(Number of servers, Arrival rate, Average duration)

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.

ERLANGC(Number of servers, Arrival rate, Average duration)

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.

EXP(Number)

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

FIND(Text to find, Text to search [, Starting character])

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.

FINDITEM(List, Text)

The FINDITEM function searches a list for a matching item using a text input. If a match is found, it returns the corresponding item from the list.

Line item to search [FIRSTNONBLANK: Mapping, FIRSTNONBLANK: Mapping 2, etc.]

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

FIRSTNONZERO(Value 1, Value 2, [etc.])

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

FV(Interest rate, Number of periods, Payments [, Present value] [, Payment timing])

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.

HALFYEARTODATE(Line item to cumulate)

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.

HALFYEARVALUE(Line item)

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

HIERARCHYLEVEL(List[, Direction[, Level type]])

Use HIERARCHYLEVEL to find a coordinate's position in a given list. Given a value in a line item, this function uses its coordinate to identify its level in the specified list. This can help you ‌determine how far the item is from the root (top-level ancestor) or from the furthest leaf (bottom-level descendant) in the list.

IF Boolean argument THEN Result 1 ELSE Result 2

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

INPERIOD(Date to test, Time period)

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.

IPMT(Interest rate, Period to examine, Number of periods, Present value [, Future value] [, Payment timing])

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.

The IRR function has two different syntaxes. One operates on transactions expressed as cash flows with a time dimension. And the other one operates on transactions expressed as pairs of dates and cash flows, which is a direct equivalent of Excel's XIRR. They both are called IRR, but take different arguments. The syntax that applies depends on whether you use more or less than two arguments with the function. 

IRR (Cash flows [, Estimate])

IRR (Cash flows, Dates, Transaction list [, Estimate])

The IRR function calculates the internal rate of return (IRR) for a series of cash flows, which can be positive (inflows) or negative (outflows). This function can be used either with all transactions over a timescale, or with specified transactions on certain dates. It automatically adjusts the calculation based on the timescale of the cash flow data, and returns the annualized rate at which the net present value equals zero.

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.

ISANCESTOR(Ancestor, Descendant)

The ISANCESTOR function takes two list or time period values. It returns TRUE if the first is an ancestor of the second. Ancestors are an item's parent, parent's parent, and so on.

ISBLANK(Value to test)

The ISBLANK function returns true for values that are blank.

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.

ISFIRSTOCCURRENCE(Values to compare, List dimension to search)

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

ISNOTBLANK(Value to test)

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

ITEM(List)

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

ITEMLEVEL(Item[, Direction])

Use ITEMLEVEL to find a given item's position within its list. The list is identified based on the given item's data type. You can use this function to find the distance from the item to either its root ancestor or its furthest leaf descendant.

LAG(Value to offset, Offset amount, Substitute value [, Non-positive behavior, List])

LAG returns a value from a preceding position within the specified dimension. 

Line item to search[LASTNONBLANK: Mapping, LASTNONBLANK: Mapping 2, etc.]

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

LEAD(Value to offset, Offset amount, Substitute value [, Non-positive behavior, List])

LEAD returns a subsequent position within the specified dimension. 

LEFT(Text [, Number of characters]) 

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

LENGTH(Text to evaluate)

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

LN(Number)

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.

LOG(Number, Base)

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

Values to lookup[LOOKUP: Mapping, LOOKUP: Mapping 2, etc.]

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

LOWER(Text [, Locale])

The LOWER function converts text values to lowercase.

MAILTO(Display text, To [, CC] [, BCC] [, Subject] [, Body text])

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

MAKELINK(Display text, URL)

The MAKELINK function generates clickable links in a module.

MAX(Value to compare, Value to compare 2, [etc.])

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.

Source[MAX: Mapping, MAX: Mapping 2, etc.]

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

MDURATION(Settlement, Maturity, Rate, Yield, frequency [, basis])

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.

MID(Text, Start position [, Number of characters])

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

Source[MIN: Mapping, MIN: Mapping 2, etc.]

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

MIN(Value to compare, Value to compare 2, [etc.])

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.

MOD(Dividend, Divisor)

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

MONTH(Value to convert, [Time period method]) 

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

MONTHTODATE(Line item to aggregate)

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

MONTHVALUE(Line item)

The MONTHVALUE function references another line item and returns the monthly time summary value for each time period within that month. The function replaces the period's individual value with the corresponding monthly summary.

MOVINGSUM(Line item to aggregate [, Start offset] [, End offset] [, Aggregation method])

The MOVINGSUM function returns the sum of values over a changing time range. As the time range moves through the data, it aggregates the values for the updated time range.

MROUND(Number to round [, Multiple to round to] [, Rounding direction])

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

NAME(List item)

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

NEXT(Expression[, List])

The NEXT function evaluates an expression based on the next value across the selected dimension.

NEXTVERSION(Expression)

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

NPER(Interest rate, Payments, Present value [, Residual value] [, Timing])

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.

The NPV function has two different syntaxes. One operates on transactions expressed as cash flows with a time dimension. And the other one operates on transactions expressed as pairs of dates and cash flows.

NPV(Discount rate, Cash flows)

NPV(Discount rate, Cash flows, Dates, Transaction list)

The NPV function calculates the net present value (NPV) for a series of cash flows, which can be positive (inflows) or negative (outflows), using a constant interest rate. This function can be used either with all transactions over a timescale, or with specified transactions on certain dates. It automatically adjusts the calculation based on the timescale of the cash flow data, and returns the total present value of those future cash flows.

OFFSET(Value to offset, Offset amount, Substitute value [, List])

The OFFSET function returns a value from a selected dimension, either preceding or following the current value in that dimension.

PARENT(Child value)

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

PERIOD(Date)

The PERIOD function converts a date to a time period. 

PMT(Interest rate, Number of periods, Present value [, Future value] [, Timing])

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.

POST(Value to post, Offset amount [, List]) 

The POST function helps you shift or move a number, such as a sales amount or order quantity, forward or backward along a dimension. If multiple values are offset to the same target item in the dimension, the POST function adds them together.

POWER(Number, Power)

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

PPMT(Interest rate, Period to examine, Number of periods, Present value [, Future value] [, Timing])

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.

PREVIOUS(Expression [, List])

The PREVIOUS function evaluates an expression based on the preceding value across the selected dimension.

PREVIOUSVERSION(Expression)

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

PRICE(Settlement, Maturity, Rate, Yield, Redemption, Frequency[, Basis])

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

PROFILE(Numbers to change, Profile [, List])

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

PV(Interest rate, Number of periods, Payments, Future value, Payment timing)

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

QUARTERTODATE(Line item to aggregate)

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

QUARTERVALUE(Line item)

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

RANK(Source values [, Direction] [, Equal value behavior] [, Include value] [, Ranking groups])

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

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

RATE(Number of periods, Payments, Present value[, Future value[, Payment timing[, Rate estimate]]])

The RATE function calculates the interest rate for a loan or investment based on the duration, payment amounts, and the present and future values.

RIGHT(Text [, Number of characters])

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

ROUND(Number to round [, Number of decimal places] [, Rounding direction] [, Rounding method])

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

Source[SELECT: Target item]

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

SIGN(Number)

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.

SLA(Number of servers, Target response time, Arrival rate, Average duration)

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

SPREAD(Value to divide, Entity count [, List])

The SPREAD function divides a value evenly over multiple entities. 

SQRT(Number)

The SQRT function calculates the square root of a number.

START(Time period)

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

SUBSTITUTE(Text to search in, Text to find, Replacement text)

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

Values to sum[SUM: Mapping, SUM: Mapping 2, etc.]

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

TEXT(Number to convert)

The TEXT() function converts numeric values to text.

Values to list[TEXTLIST: Mapping, TEXTLIST: Mapping 2, etc.]

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.

TEXTLIST(Text to concatenate, Separator, List to reference [, Duplicate behavior])

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

TIMESUM(Line item to aggregate [, Start period] [, End period] [, Aggregation method])

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

TRIM(Text)

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

UPPER(Text [, Locale])

The UPPER function converts text values to uppercase.

VALUE(Value to convert)

The VALUE function converts text representations of numbers into numeric values.

WEEKDAY(Date [, First day of the week])

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

WEEKTODATE(Line item to aggregate)

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

WEEKVALUE(Line item)

The WEEKVALUE function references another line item and returns the weekly time summary value for each time period within that week. The function replaces the period's individual value with the corresponding weekly summary.

YEAR(Value to convert, [Time period method]) 

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

YEARFRAC(Start, End[, Basis])

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.

YEARTODATE(Line item)

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

YEARVALUE(Line item)

The YEARVALUE function references another line item and returns the yearly time summary value for each time period within that year. The function replaces the period's individual value with the corresponding yearly summary.

YIELD(Settlement, Maturity, Rate, Price, Redemption, Frequency [, Basis])

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