You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 29 Next »

Special functions

 

Function

Description

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;
Double firstValue()

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

 DatefirstValue('L_DATE')
Project11/1/20151/1/2015
Project15/1/20151/1/2015
Project23/1/20153/1/2015
Project28/1/20153/1/2015
Double forEachRow('expression')

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:

 

 

Ind1

Ind2

forEachRow('M_IND_1 * M_IND_2')

M_IND_1 * M_IND_2

Member

 

5

30

80

150

 

DrillDownMember1

3

20

60

60

 

DrillDownMember2

2

10

20

20

Double forEachRow('expression','aggregation')Computes the expression on data set row level and calculates the aggreagation based on second parameter from particular results. Aggregation can include SUM, MIN, MAX, AVG, COUNT, DCOUNT.
Double formatNumber(number value)Formats the value according the indicator's format from settings.
Double formatNumber(number value, 'String pattern')Formats the value according the indicator's format from settings. String pattern allows you to control, how the format specified.
Double lastValue()

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

ProjectDatelastValue('L_DATE')
Project11/1/20155/1/2015
Project15/1/20155/1/2015
Project23/1/20157/1/2015
Project27/1/20157/1/2015


void eachMember(String attribute) { expression }

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

L_ATTRIBUTE_1

L_ATTRIBUTE_2

Ind1

Ind2

def result = 0

eachMember('L_ATTRIBUTE_2') { result = M_IND_1 * M_IND_2 }

return result

M_IND_1 * M_IND_2

Value

 

5

30

80

150

 

Value1

3

20

60

60

 

Value2

2

10

20

20

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:

 

 

Ind1

Ind2

membersSum( { M_IND_1 * M_IND_2 } )

M_IND_1 * M_IND_2

Member

 

5

30

80

150

 

DrillDownMember1

3

20

60

60

 

DrillDownMember2

2

10

20

20

Refer to Formula best practices for correct usage.

Double membersSum(String levelCode, { expression } )

Computes the expression for particular members of the defined levelCode and calculates the sum from 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 maximul 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' } }
Double timeAttribute(String levelCode){ expression }

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:

 

Population

attributeCode()

Prague

1200000

L_CITY

Berlin

3000000

L_CITY

London

7825200

L_CITY

String memberIdentifier()

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

 

Population

memberIdentifier()

Prague

1200000

[L_CITY= {Prague}]

Berlin

3000000

[L_CITY= {Berlin}]

London

7825200

[L_CITY= {London}]

String memberValue()

Returns the value of current member. Example:

 

Population

memberValue()

Prague

1200000

Prague

Berlin

3000000

Berlin

London

7825200

London

rank() { expression }

Returns numerical order (rank) of the indicator applied in the expression within used drill-down. Example:

User

Score

rank()

Peter

90.3

2

John

92.7

1

Anna

89.7

3

rankInner() { expression }

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

Drill-downSalesrankInner()
Coffee750001
Caffe Latte250003
Caffe Mocca350002
Decaf Espresso150001
Tea1000002
Lemon1000001
rankInner(true) { expression }

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

Drill-downSalesrankInner(true)
Coffee750002
Caffe Latte250002
Caffe Mocca350001
Decaf Espresso150003
Tea1000001
Lemon1000001
setDebugOn(true)

Enables debug mode. If formula contains 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 to use 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:

Date

M_INDICATOR

withoutDateTime() { M_INDICATOR }

1/12 - 12/12

1000

3000

1/1/2013 - 1/31/2013

100

3000

withoutDrillDown() { expression }

Opt-out from applied Drill-downs. Example:

Country

M_INDICATOR

withoutDrillDown() { M_INDICATOR }

+UK

3000

3000

--London

1000

3000

--Manchester

1000

3000

--Oxford

1000

3000

withoutFilter() { expression }

 

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

City

M_INDICATOR

withoutFilter() { M_INDICATOR }

Paris

1000

3000

London

900

3000

Berlin

1100

3000

Passing parameters to time formula

It is possible to define the time entry by formula. Following functions are applicable for these kind of formulas only.

Function

Description

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

Consider following example - we have several indicators with codes M_NAME_1, M_NAME_2 and M_NAME_3. These indicators are used in formulas 1 - 3. The time area is defined by time formulas 1 - 5.

 

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

Getting User Information

It is possible to obtain information about logged in user for your reporting needs.

FunctionDescription
String getSignedUserName()Returns name of currently signed in user.
String getSignedUserSurname()Returns surname of currently signed in user.
String getSignedUserEmail()Returns email of currently signed in user.
String getSignedUser()Returns username of currently signed in user.

Working with lists and arrays

BellaDati supports all Arrays from https://docs.oracle.com/javase/7/docs/api/java/util/Arrays.html and ArrayUtils from https://commons.apache.org/proper/commons-lang/javadocs/api-2.6/org/apache/commons/lang/ArrayUtils.html.

Syntax: first define name of the package, then use desired method.

Example:

def int[] a = [1,2,3]
a = ArrayUtils.add(a, 0)
Arrays.sort(a)
return a[3]

Next Steps

  • No labels