Page History

String[] comments()

Return array of text inside comments.

ArrayUtils.toString(comments())

String[] commentsDetails()

Returns array of comments in format datetime + text, e.g.: 216-08-12T15:24:22.486;text.

ArrayUtils.toString(commentsDetails())

void filter(String filterExpression, { expression } )

Evaluates the passed expression with the specified filter. For example:

filter('M_MEASURE > 100') { L_ID_COUNT } 

Double aggregatePrevLevel(int countOfPrevlevels, { expression } )

Returns the aggregated value of the embedded expression. The aggregation is computed for the specified upper level. For example:

total = aggregatePrevLevel(1, {
  cumulateFromTime(actualYear(), {
    'M_NAME_1' + 'M_NAME_2'
  });
});
current = cumulateFromTime(actualYear(), {
    'M_NAME_1' + 'M_NAME_2'
});
return current / total;

Returns the lowest value of selectedofselectedlevelselected level(measure). For example:

Computes the expression on data set row level and calculates the sum from particular results. Following example shows the difference of using multiplication within the forEachRow() method and outside:

Returns the lowest value of selected of the selected level (measure). For example:

void eachMember(String attribute) { expression }

Computes the expression for particular attribute values defined by attribute parameter.

Refer to Formula best practices for correct usage.

Double members(String path, { expression } )

Computes the expression for desired drill-down member values. Example:

return members('[L_LEVEL_1=VAL][L_LEVEL_2="VAL1,VAL2"]', {
M_NAME_1 * M_NAME_2
})

This example returns the value of indicator M_NAME_1 aggregated for specified members.

Refer to Formula best practices for correct usage.

Double membersSum({ expression } )

Computes the expression for particular members and calculates the sum from particular results. Following example shows the difference of using multiplication within the membersSum() method and outside:

Refer to Formula best practices for correct usage.

Double membersSum(String levelCode, { expression } )

Computes the expression for particular members of the defined levelCode and calculatesthesumfrom particular results.

Refer to Formula best practices for correct usage.

Double membersAvg({ expression } )

Computes the expression for particular members and calculates the average value from particular results.

Refer to Formula best practices for correct usage.

Double membersAvg(String levelCode, { expression } )

Computes the expression for particular members of the defined levelCode and calculates the average value from particular results.

Refer to Formula best practices for correct usage.

Double membersMin({ expression } )

Computes the expression for particular members and calculates the minimal value from particular results.

Refer to Formula best practices for correct usage.

Double membersMin(String levelCode, { expression } )

Computes the expression for particular members of the defined levelCode and calculates the minimal value from particular results.

Refer to Formula best practices for correct usage.

Double membersMax({ expression } )

Computes the expression for particular members and calculates the maximum value from particular results.

Refer to Formula best practices for correct usage.

Double membersMax(String levelCode, { expression } )

Computes the expression for particular members of the defined levelCode and calculates the maximum value from particular results.

Refer to Formula best practices for correct usage.

Double dateAttribute(String levelCode){ expression }

Computes the expression for particular members of the defined levelCode on defined dates.

dateAttribute('L_DATE') {dateInterval('2014-01-01','2014-12-01') { 'M_NAME_1' + 'M_NAME_2' } }

Computes the expression for particular members of the defined levelCode on defined time.

timeAttribute('L_TIME') {timeInterval('10:00:00','12:00:00') { 'M_NAME_1' + 'M_NAME_2' } }

String attributeCode()

Returns the attribute code of current member. Example:

Method to load translations from referenced data set.

localize('TRANSLATIONS', 'L_ORIG', firstValue('L_STATE'));

String memberIdentifier()

Returns the attribute code and value of current member in following form [L_CODE={VALUE}]. Example:

String memberValue()

Returns the value of current member. Example:

printComments()

rank() { expression }

Returns numerical order (rank) of the indicatorappliedintheexpression within used drill-down. Example:

rank('L_DRILLDOWN', 'M_INDICATOR')

rank('L_DRILLDOWN', 'MEMBER', 'M_INDICATOR')

Rank will calculate over specific drill down and member

withoutFilter() {
	rank('L_CITY', 'Aberdeen', 'M_VISITS')
}

Returns numerical order (rank - ascending) of the indicator applied in the expression within all used drill-downs in the table. Example:

Returns numerical order (rank - descending) of the indicator applied in the expression within all used drill-downs in the table. Example:

setDebugOn(true)

Enables debug mode. Ifformulacontains error, table cell will contain detailed stack trace about error, chart and KPI label won't be rendered and error detail will be printed out.

We recommend using this function only while debugging. If not debugging, delete or mark it as comment:

//setDebugOn(true)

withoutDateTime() { expression }

Opt-out from applied Date and Time intervals. Example:

withoutDrillDown() { expression }

Opt-out from applied Drill-downs. Example:

In cases, whentherearemultipledrill-downsappliedinthetable, some of the drill-downs can be excluded from the withoutDrillDownFunction function (the aggregation for the upper level will be displayed).

withoutFilter() { expression }

Opt-out from applied filters. Example: (Filter is set to SEGMENT=SMB)

withoutReportFilter() { expression }

withoutViewFilter() { expression }

loadData('L_DRILLDOWN', 'M_INDICATOR')

Allows to load values of an indicator for all members of specifiedattribute. it can greatly improve the performance of formulas. The function returna map of members and their values. This map can be accessed by using function getMapValue()

data = loadData('L_DRILLDOWN', 'M_INDICATOR')
getMapValue(data, '[memberId]')

The memberId has to have following format: [memberId] = [L_ATTRIBUTE={Value}]. Usually, the function is used toghether with withoutDrillDown().

withoutDrillDown() { 
data = loadData('L_COUNTRY', 'M_NUMBERS_BUILT')
getMapValue(data, '[L_COUNTRY={Germany}]')
  }

It also possible to use rank or aggregation such as MAX, MIN etc.:

data = loadData('L_DRILLDOWN', 'M_INDICATOR_rank()')
getMapValue(data, '[memberId]') //will return M_INDICATOR_rank() 

data = loadData('L_DRILLDOWN', 'M_INDICATOR@MAX')
getMapValue(data, '[memberId]') //will return the highest value of indicator

Instead of indicator, users can also retrieve first of last value of an attribute.

data = loadData('L_DRILLDOWN', 'L_ATTRIBUTE_LASTVALUE')

data = loadData('L_DRILLDOWN', 'L_ATTRIBUTE_FIRSTVALUE')

void set(String name, Object value)

Sets the parameter value.

Object get(String name)

Loads the parameter value.

Object indicator()

Returns indicator from the context of the row of current table. This function returns also values of formula defined indicators (defined in report). Example:

value(actualYear(),'actualMonth - 1m - 1d',indicator())

Time formula 1:
M_NAME_1

Time formula 2:
M_NAME_2

Time formula 3:
M_NAME_3

Time formula 4:
s = get('suffix');
return value('M_NAME' + s);

Time formula 5:
value(actualYear(),
'now-1m',indicator())

Formula 1:
set('suffix', '_1');
return M_NAME_1;

1000

2000

3000

1000

1000

Formula 2:
set('suffix', '_2');
return M_NAME_2;

1000

2000

3000

2000

2000

Formula 3:
set('suffix', '_3');
return M_NAME_3;

1000

2000

3000

3000

3000

M_NAME_1

1000

2000

3000

N/A

1000

M_NAME_2

1000

2000

3000

N/A

2000

M_NAME_3

1000

2000

3000

N/A

3000