webi report function overview

8/18/2019 Webi Report Function Overview

1/23

Webi Report Function Overview

Below are the lists of available Webi 3.1 report functions and will describe each & every functions along with example.Webi 4.0 reports are also having some functions with some additional futures.

Functions Function Output Syntax Sample ResultAbs Returns the Absolute value of a

Number

Num Abs(number) =Abs(-97324)

=Abs(54354)

97324

54354Asc ASCII value of a Character. Onlyone Character it will define theASCII value, even if you addmore than one Character.

Int Asc(Character) = Asc(“M”) =Asc(“A”)

7765

Average Average of the Measure values.Average function mostly usefulwhen you do average on a totalof table measures. Averagewould provide the averagewhere total Measures dividedby no of rows of the table

NumAverage(Measure[;Include Empty])

=Average([Amount])

Desc AmountA 2540B 3210C 1243D 5214E 8003

F 98721Sum 118931Average 19821.83

Block Name Returns the Table Name wherethis Block Name function isused.

String BlockName() =BlockName() Master Table – Nameof the table

Ceil Rounds a Number up to thenearest Integer

Num Ceil(Number) =Ceil(1234.51)=Ceil(1234.49)=Ceil(-1234.1)

12351235-1234

Char Character Associated with ASCIIcode

StringChar(ascii_code)

=Char(100)=Char(77)=Char(42)

dM*

ColumnNumber

Displays the column Numberwhere this function used in atable

Int ColumnNumber()CN

=ColumnNumber()

3 – Column Numberfunction used in 3 rd column of that table

Concatenation Join 2 strings and make it single String Concatenation(first_string;Second_string)

=Concatenation("SAP";" BusinessObjects")

SAP Business Objects

Connection The parameters of thedatabase connection used by adata provider. Data Providername must enclosed in squarebracket.

StringConnection(dp)

=Connection([Query 1])

DB Layer: "OracleOCI". DB Type: "Oracle11".

Cos Cosine of an angle Num Cos(angle) =Cos(360)=Cos(200)

-0.280.49

Count Number of Values / rows in adimensions or Measures.Includes distinct values only(default for dimensions) or allvalues (default for measures) inthe calculation

intCount(obj[;IncludeEmpty] [;Distinct|All])

=Count([Desc])=Count([Amount])

Desc AmountA 2540B 3210C 1243C 5214E 8003F 98721


2/23

CountDim

5

CountMeasure 6

Current Date Display the Current Dateformatted according to theregional Settings in your server

Date CurrentDate() =CurrentDate() 12/24/13

Current Time Display the Current Time

formatted according to theregional Settings in your server

Time CurrentTime() =CurrentTime() 2:05:54 PM

Current User Logon of the Current User String CurrentUser() =CurrentUser() devuserData Provider Name of the Data provider

containing a report ObjectStringDataProvider(obj)

=DataProvider([Country])

Query 1 – this isDefault Data providername

Data Providerkey Date

Key Date of the Data Provider.Data Provider name mustenclosed in square bracket.

DateDataProviderKeyDate(dp)

=DataProviderKeyDate([dp])

24 December 2013

Data Providerkey Date

Caption

Key Date Caption of the DataProvider. Data Provider name

must enclosed in squarebracket.

Stri8ngDataProviderKeyDate

Caption(dp)

=DataProviderKeyDateCaption([dp])

Returns "Currentcalendar date" if the

keydate captionin the dp dataprovider is "Currentcalendar date".

Data ProviderSQL

SQL Query generated by theData Provider

StringDataProviderSQL([dp])

=DataProviderSQL([dp1])

Select object1 fromtable…

Data providerType

Type of a Data Provider –whatkind of sources used for thatreport – Example - Universe,Free hand SQL, etc.,

StringDataProviderType([dp])

=DataProviderType([dp1])

Universe

Day Name Day Name in the Date. Theinput date must be a variable.You cannot specify the datedirectly, as inDayName("12/24/2013").

StringDayName(date)

= =DayName([SalesDate])

Sales Date Day Name6/16/2010 Wednesday6/21/2010 Monday6/23/2010 Wednesday6/25/2010 Friday6/26/2010 Saturday

Day NumberOf Month

Return the Day number of thatmonth

IntDayNumberOfMonth(date)

=DayNumberOfMonth([Sales Date])

Sales Date Day Number6/16/2010 166/21/2010 216/23/2010 236/25/2010 256/26/2010 26

Day NumberOf Week

Return the Day number of thatweek. Example 6/16/2010 isWednesday and Webi reportwould consider Monday asStart of the Week. So DayNumber for that week is 3.

IntDayNumberOfWeek()

=DayNumberOfWeek([Sales Date])

Sales Date WeekNumber

6/16/2010 36/21/2010 16/23/2010 36/25/2010 56/26/2010 6

Day NumberOf Year

Return the Day number of thatYear

IntDayNumberOfYear(date)

=DayNumberOfYear([Sales Date])

Sales Date Day of Year4/5/2010 954/7/2010 974/8/2010 98

4/12/2010 1024/13/2010 103


3/23

Days Between Number of Days between 2dates

IntDaysBetween(first_date;last_date)

=DaysBetween([SalesDate];CurrentDate())

; DaysBetween

3/12/2010 13833/16/2010 13793/17/2010 13783/22/2010 13733/23/2010 1372

*Current Date – 12/24/13

Document

Author

Logon of the Document Creator String

DocumentAuthor()

=DocumentAuthor(

)

devuser

DocumentCreation Date

Date on which a document wascreated

DateDocumnetCreationDate()

=DocumnetCreationDate()

12/10/13

DocumentCreation Time

Time on which a document wascreated

TimeDocumnetCreationTime()

=DocumnetCreationTime()

2:55:59 PM

DocumentDate

Date on which a document waslast saved

DateDocumnetDate()

= DocumnetDate() 12/10/13

DocumentName

Name of the document / report StringDocumnetName()

= DocumnetName() Sample Webi Report

DocumentOwner

Logon user name of the ownerof the document (the lastperson who saved thedocument)

StringDocumentOwner()

=DocumentOwner()

devuser

DocumentPartiallyRefreshed

Will tell you whether the reportis fully or partially refreshed.

BoolDocumentPartiallyRefreshed()

=DocumentPartiallyRefreshed()

Returns 1 & 0. 0 – Means Fully refreshed.1 – Means partiallyrefreshed. You can usethese values in IFfunction to displayTRUE / FALSE

DocumentTime

Time on which a document waslast saved

TimeDocumnetTime()

= DocumnetTime() 4:25:39 PM

Drill Filter Drill Filters applied to a reportor an Object in drill mode

String DrillFilters([Obj|Separator])

=DrillFilters() Consider report hasdrill on Country andYear. If the DrillFilterreturn US – meansDrill Filter applied onCountry. US 2013 – Means Drill filterApplied on County &year.

Euro ConvertFrom

Converts a Euro amount toanother currency. The currencycode must be the code of oneof the 12 EU currencies whosevalues were fixed in relation tothe Euro prior to their abolitionin January 2002. If it is not, thefunction returns #ERROR. Thecurrencies are:

Code Currency DescBEF Belgian franc

numEuroConvertFrom(euro_amount;curr_code;round_level)

=EuroConvertFrom(1000;"FRF";2)

=EuroConvertFrom(1000;"GRD";1)

=EuroConvertFrom(1000;"ITL";0)

6559.57

340,750.1

1,936,270


4/23

DEM German markGRD Greek drachmaESP Spanish pesetaFRF French francIEP Irish puntITL Italian liraLUF Luxembourg francNLG Dutch guilderATS Austrian schillingPTS Portuguese escudoFIM Finnish mark

Euro ConvertTo

Converts an amount to Euros.Currency code can be used asmentioned in the above table

numEuroConvertTo(noneuro_amount;curr_code;round_level)

=EuroConvertTo(6559.57;"FRF";2)

=EuroConvertTo(6559.57;"DEM";2)

1000

3,353.85

Euro FromRound Error

Returns the Rounding decimalplace amount in theconversion. Example,EuroConvertFrom(1000;"FRF";1) return 6559.60 whereaswithout rounding this would be6559.57, the difference is 0.03.The difference amount 0.03will be returned when you useEuroFromRoundError(1000;"FRF";1).

numEuroFromRoundError(euro_amount;curr_code;round_level)

=EuroFromRoundError(1000;"FRF";1)

=EuroFromRoundError(1000;"GRD";1)

=EuroFromRoundError(1000;"NLG";1)

0.03

0 – means there is nodifference in roundingthe decimal places.

-0.01 –> 2,203.71when you round thisamount 2,203.7 andthe difference is -0.01

Euro To RoundError

Returns the Rounding decimalplace amount in theconversion. Same as above.

numEuroToRoundError(noneuro_amount;curr _code;round_level)

=EuroToRoundError(1000;"FRF";1)

-0.05 ->152.45 whilerounding it would be152.4 and thedifference is -0.05

Even Determines the Number is Evenor not

Bool Even(number) =Even(10)

=Even(11)

1 – This is evenNumber0 – Not an evenNumber

Exp Exponential (e raised to apower). An exponential is theconstant e (2.718...) raised to apower.

Num Exp(Number) =Exp(2)=Exp(3)

7.3920.09

Fact Factorial of an Integer.Factorial of number is multiple

of all the integers from 1 tonumber. If FACT(4) then itwould calculate 1*2*3*4= 24an FACT(6) is1*2*3*4*5*6=720

Num Fact(number) =Fact(4)=Fact(6)

24720

Fill Concatenate the string byrepeating N times.

StringFill(repeating_string;num_repeats)

=Fill("BusinessObjects ";3)

=Fill("SAP ";5)

Business ObjectsBusiness ObjectsBusiness Objects

SAP SAP SAP SAP SAPFirst Returns the first value in a data Input_type =First([Country]) USA – First value of


5/23

set (dimension or MeasureObjects). Used in a breakfooter, First returns the firstvalue in the in the break.Used in a section footer, Firstreturns the first value in thesection.Used in a table footer,

First([Sales]) returns the firstvalue of [Sales] in the table.

First(dimension|measure) =First([Sales])

Country Object.102364.55 – first valueof the Sales Measurebased on your Querydata set.

Floor Round the Number down tothe Nearest integer

Int Floor(number) =Floor(1234.61)=Floor(-1234.61)

1234-1235

Force Merge ForceMerge is the equivalentof the BO Desktop IntelligenceMulticube function. Includessynchronized dimensions inmeasure calculations when thedimensions are not in themeasure's Calculation context /Data Provider.

When you have more than onedata provider and one DP doesnot have a synchronizeddimension and you need tomerge that DP measure withother DP, ForceMerge wouldhelp you to get the Measureamount in single Object.

ForceMerge([Sales]) returnsthe value of [Revenue], takinginto account any synchronizedDimensions that do not appearin the same block as the [Sales]measure.

NumForceMerge(number)

=ForceMerge([Sales])

104342.50

Format Date Formats a date according tothe Specified format

stringFormatDate(date;format_string)

=FormatDate(CurrentDate();"yyyy/dd/MM")=FormatDate(CurrentDate();"MM/yyyy")

2013/24/12

12/2013

FormatNumber

Formats a Number according tothe Specified format

stringFormatNumber(number;format_string)

=FormatNumber([Sales];"#,##0")=FormatNumber([Sales];"#,##0.00")

12,358,210

12,358,210.56

Get ContentLocale

Returns the Local (Desktop – where you are accessing thereport) Language of your reportData content

StringGetContentLocale()

=GetContentLocale()

en

Get DominantPreferredViewing

Returns the dominant locale inthe user's Preferred ViewingLocale group. The Translation

StringGetDominantPreferredViewingLocale()

=GetDominantPref erredViewingLocale()

en_US


6/23

Locale() Manager Guide lists all theDominant Preferred ViewingLocales. Please refer from SAPPortal for more information(page 51).http://help.sap.com/businessobject/product_guides/boexir4/en/xi4_translation_manageme

nt_tool_en.pdf

Get Locale User’s local system used formatfor their Webi Interface(example, menu items andbutton text)

String GetLocale() =GetLocale() en

Get Localized This function mostly used inthe translation (languageTranslator) purpose and wouldreturn the Users preferredViewing Locale.• The string parameter can be astring in any formula (forexample, in a cell, an alertermessage or a variabledefinition).• When designing a report, youcan use the commentparameter to provide furtherinformation to helpTranslators translate the string.The comment appears with thestring in the TranslationManager tool which translatorsuse to translate reports.

stringGetLocalized(string[;comment])

=GetLocalized("Sales Revenue";"Max20 characters")

Sales Revenue

Get PreferredViewing Locale

User's preferred locale forviewing document data (thePreferred Viewing Locale)

stringGetPreferredViewingLocale()

=GetPreferredViewingLocale()

en

HTML Encode Applies HTML encoding rules toa string

stringHTMLEncode(html)

=HTMLEncode("http://www.sap.com")

http://www.sap.com

If Then Else Returns a value based onwhether an expression is trueor false

If bool_value Thentrue_value [Elsefalse_value]

=If(10 >5) Then"TRUE" Else"FALSE"

=If(10 >11) Then"TRUE" Else If(5 >7)Then "TRUE" Else"FALSE"

TRUE

FALSE

Init Cap Capitalizes the First letter ofthe String

String InitCap(string) =InitCap("report") Report

Interpolation Calculates empty measurevalues by interpolation.

•Interpolation is particularly

numInterpolation(measure[;PointToPoint|Linear]

=Intepolation([Measurement])

Country Measure

Interpol

http://help.sap.com/businessobject/product_guides/boexir4/en/xi4_translation_management_tool_en.pdfhttp://help.sap.com/businessobject/product_guides/boexir4/en/xi4_translation_management_tool_en.pdfhttp://help.sap.com/businessobject/product_guides/boexir4/en/xi4_translation_management_tool_en.pdfhttp://help.sap.com/businessobject/product_guides/boexir4/en/xi4_translation_management_tool_en.pdfhttp://help.sap.com/businessobject/product_guides/boexir4/en/xi4_translation_management_tool_en.pdfhttp://help.sap.com/businessobject/product_guides/boexir4/en/xi4_translation_management_tool_en.pdfhttp://help.sap.com/businessobject/product_guides/boexir4/en/xi4_translation_management_tool_en.pdfhttp://help.sap.com/businessobject/product_guides/boexir4/en/xi4_translation_management_tool_en.pdfhttp://help.sap.com/businessobject/product_guides/boexir4/en/xi4_translation_management_tool_en.pdf


7/23

useful when you create a linegraph on a measure thatcontainsmissing values. By using thefunction you ensure that thegraph plots a continuous linerather thandisconnected lines and points.

• Linear regression with lea stsquares interpolationcalculates missing values bycalculating a lineequation in the form f(x) = ax +b that passes as closely aspossible through all theavailable valuesof the measure.• Point -to point interpolationcalculates missing values bycalculating a line equation inthe form f(x)= ax + b that passes throughthe two adjacent values of themissing value.• The sort order of themeasure impacts the valuesreturned by Interpolation.• You cannot apply a sort or aranking to a formula containingInterpolation.• If there is only one value in

the list of values, Interpolationuses this value to supply all themissing values.• Filters applied to aninterpolated measure canchange the values returned byInterpolationdepending on which values thefilter impacts.

[;NotOnBreak|(reset _dims)][;Row|Col])

“Measure ” – Anymeasures

“PointTo-Point|Linear ” - The

interpolationmethod: Keyword• PointToPoint -point-to-pointinterpolation• Linear - linearregression with leastsquaresInterpolation.

By Default“PointToPoint”would be taken.

“NotOnBreak|reset_dims” – • NotOnBreak -

prevents the functionfrom resetting thecalculation on blockand section breaks• reset_dims - the listof dimensions used

to reset theinterpolation

“Row|Col ” - Sets thecalculation direction

By Default “Row”would be taken.

ment

ation([Measure

ment])

USA 12 12CANADA 13JAPAN 14 14INDIA 15 15CHINA 16UK 17GERMANY 18 18

Is Date Validate / Check whether avalue is a Date

Bool IsDate(obj) =IsDate("12/24/2013")

=IsDate(CurrentDate())

0 –FALSE (Value is notan Date)

1- TRUE (Value is aDate)

Is Error Validate / Check whether areturns an error

Bool IsError(obj) =IsError(100/0)

=IsError(100/10)

1 – 100/0 wouldreturn ERROR in thereport

0 – 100/10 wouldreturns 10 and there isno error

Is Logical Determines whether a value is Bool IsLogical(obj) =IsLogical(IsString([ 1 - TRUE


8/23

Boolean.• IsLogical returns a boolean value that you can use in the Iffunction.• If you place IsLogical directlyinto a column, it returns aninteger (1=true; 0=false). Youcan format

this integer using a Booleannumber format.

Country]))

Is Null Determines whether a value isnull

Bool IsNull(obj) =If (IsNULL([Sales]))then 0 else [Sales]

Return the valuebased on the Salesobject data

Is NUmber Determines whether a value isa number

Bool IsNUmber(obj) =If(IsNumber([Sales]))then 0 else [Sales]


Is PromptAnswered

Returns whether a prompt hasbeen answered. Must enclosethe name of the data providerin square brackets.

BoolIsPromptAnswered([dp;]prompt_string)

=IsPromptAnswered("Enter CountryName")

1 – TRUE - if theprompt identified bythe text "EnterCountry Name" hasbeen answered.

Is String Determines whether a value isString

Bool IsString(obj) =If(IsString([CountryCode])) then“TRUE” else“FALSE”


Is Time Determines whether a value isa Time

Bool IsTime(obj) =IsTime(CurrentTime())

1 – Return TRUE

Last Returns the Last value in a dataset (dimension or MeasureObjects). Used in a breakfooter, Last returns the Lastvalue in the in the break.Used in a section footer, Lastreturns the Last value in thesection.Used in a table footer,Last([Sales]) returns the Lastvalue of [Sales] in the table.

input_typeLast(dimension|measure)

=Last([Country])

=Last([Sales])

YEMAN – Last value ofCountry Object.2364.55 – Last valueof the Sales Measurebased on your Querydata set.

Last Day OfMonth

Date of the last day in a month DateLastDayOfMonth(date)

=LastDayOfMonth(CurrentDate())

12/31/13

Last Day OfWeek

Date of the last day in a Week.The function treats Monday asthe first day of the week.

DateLastDayOfWeek(date)

=LastDayOfWeek(CurrentDate())

12/29/13

Last ExecutionDate

The Date on which a DataProvider was last refreshed

dateLastExecutionDate([dp])

=LastExecutionDate([Sales])

12/24/13

Last ExecutionDuration

Time in seconds taken by thelast refresh of a data provider

numLastExecutionDuration(dp)

=LastExecutionDuration([Sales])

40 Seconds

Last ExecutionTime

Returns a time when a dataprovider was last refreshed

timeLastExecutionTime(d

=LastExecutionTime([Sales])

4:29:54 PM


9/23

p)Left The leftmost characters of a

string. The number ofcharacters to return from theleft.

stringLeft(string;num_chars)

=Left("SAPBusinessObjects";5)

=Left([Country];3)

SAP B

AUS for AustriaLeft Pad Pads a string on its left with

another string.

• If length is less than thelength of left_string andpadded_string combined,left_string is truncated.• If length is less than or equalto the length of padded_string,the function returnspadded_string.• If length is greater than thelengths of padded_string andleft_string combined,left_string is repeated orpartially repeated enoughtimes to fill out the length

stringLeftPad(padded_strin

g;length;left_string)

=LeftPad("South";10;"West ")



West South

West WSouth

South – Left stringlength is less thanPadded String and LeftString is truncated andit will display only thePadded String

Left Trim Trims the leading spaces from aString

stringLeftTrim(trimmed_string)

=LeftTrim(" SAPBO")

=LeftTrim([Country])

SAP BO

USA – if CountryObject Has values as“ USA”

Length Number of characters in astring

Int Length(string) =Length("WebIntelligenceReport")

23

Line Number Line Number in a Block Int LineNumber() =LineNumber() 2 – Which row thefunction is used. If itused in a table in willincrease the numbersbased on the No. ofrows

Ln Natural logarithm of a number Num Ln(number) =Ln(20) 3Log Logarithm of a number in a

specified basenumLog(number;base)

=Log(100;5) 2.86

Log10 Base 10 logarithm of a number Num Log10(number) =Log10(10) 1

Lower Converts a string to lower case string Lower(string) =Lower(“SAP”) sapMatch Check whether a string

matches a pattern.The pattern can contain thewildcards "*" (replaces any setof characters) or "?" (Replacesany single character).

BoolMatch(test_string;pattern)

=Match("SAPBusinessObjects";"*B*")

1 – There is amatching pattern for“B”

Max Largest value in a set of values Input_typeMax(Dimension |Measure)

=Max([Country]) USA

Median Return Middle Value of a Num = Median([Sales]) 312,345 - If [Sales] has


10/23

Measure. If the set of numbershas an even number of values,Median takes the average ofthe middle two values.

Median(Measure) the values of 54202,312345, and 4233490.

Min Smallest value in a set of values Input_typeMin(Dimension |Measure)

=Min([Country]) AUSTRIA

Mod Remainder Number from the

division of two numbers

Num

Mod(dividend;divisor)

=Mod(102;23)

=Mod(10;3)

10

1Mode Most frequently-occurring

value in a data set. Modereturns null if the data set doesnot contain one value thatoccurs more frequently than allthe others.

Input_typeMode(dimension|measure)

=Mode([Sales])

=Mode([Country])

20 – If [Sales] hasvalues of 10, 5,20,15,20USA – If [Country] hasmost frequent valuesof USA

Month Returns the Month name of theDate

String Month(date) =Month(CurrentDate())

December

Month

Number OfYear

Returns the Month Number of

the Date.

Int

MonthNumberOfYear(date)

=MonthNumberOf

Year(CurrentDate()))

12

MonthsBetween

Return the Number of monthsbetween two dates

IntMonthsBetween(first _date;last_date)

=MonthsBetween([Sales Date];CurrentDate())

5 – If [Sales Date] is24-Jun-2013 andCurrent Date is 24-Dec-2013

Name Of Return the Name of an Objectand this function used todisplay the Object Name inTable Headers.

String NameOf(obj) =NameOf([Country])

Country

No Filter Ignore the Filters applied in thetable / block while doing thecalculation.• NoFilter(obj;Drill) does notwork in query drill modebecause the drill filters areadded to the query rather thanapplied to the report data.• If you end drill mode withdrill filters applied, the drillfilters become report filtersand can change the value ofany objects to which

NoFilter(obj;Drill) is applied

Input_typeNoFilter(obj[;All|Drill])

=NoFilter(Sum([Sales]))

Returns the total salesrevenue of all possiblerows in the block,even when rows arefiltered out of theblock.

Number OfData Providers

Return the Number of DataProviders available in a report

IntNumberOfDataProviders()

=NumberOfDataProviders()

3 – The report has 3Data Providers.

Number OfPages

Return the Number Pages ofthe report

Int NumberOfPages() =NumberOfPages() 20 – Report has 20pages

Number OfRows

Return the Number Rows in aData Provider

IntNumberOfRows([dp])

=NumberOfRows([Query 1])

200 – Data ProviderQuery 1 has 200 Rows

Odd Check whether the givenNumber is Odd or not

Bool Odd(Number) =Odd(121)=Odd(140)

1 – TRUE0 - FALSE

Page Returns the Current Page Int Page() =Page() 1 – First Page of the


11/23

Number of the Report reportPercentage Expresses a measure value as a

percentage of its embeddingcontext. By default theembedding context is themeasure total in the table. Youcan make the function takeaccount of a break in a table by

using the optional Breakargument. You can use thePercentage function acrosscolumns or rows; you canspecify this explicitly using theoptional Row|Col argument.

NumPercentage(measure[;Break][;Row|Col])

=Percentage([Sales])

Year Sales Percentage

2001 1000 102002 5000 502003 4000 40Sum 10000 100

Percentile The nth percentile of ameasure. The nth percentile isa number that is greater thanor equal to n% of the numbersin a set. You expressn% in the form 0.n.

NumPercentile(measure;percentile) - percentile- A percentageexpressed as adecimal

=Percentile([Amount];0.3)

If [Amount] has theset of numbers(100;200;300;400;500)Percentile([Amount];0.3) returns 220,This is greater than orequal to 30% of thenumbers in the set.

Pos The starting position of a textpattern in a string

IntPos(test_string;pattern)

=Pos("SAP BO";"SA")

1

Power Number raised to a Power Num Power(number;power)

=Power(2;2) 4

Previous Previous value of an object.• The default value of offset is1. Previous([Revenue];1) andPrevious([Revenue]) arefunctionally the same.• When you include the NoNullargument, the function returnsthe first non-null value of theobject beginning from the celloffset rows before the currentrow and counting backwards.• You can use extended syntaxcontext operators withPrevious.• The Self operator allows you

to refer to the previous valueof a cell when it containscontent other than one reportobject.• You must always placedimensions in parentheseseven if there is only onedimension in the list of resetdimensions.• When you specify a set ofreset dimensions you must

Input_typePrevious(dimension|measure|Self[;(reset _dims)][;offset][;NoNull])

= Previous([Country];1)

Country Sales PreviousUSA 1000UK 5000 USAUAE 4000 UK

= Previous([Sales])

Country Sales PreviousUSA 1000UK 5000 1000UAE 4000 5000

= Previous([Sales];[Country])

Country Region Sales PreviousUSA South 2000

West 4000 2000East 1000 4000

UK South 5000North 4000 5000

UAE North 3000East 5000 3000


12/23

separate them with semi-colons.• Previous is applied after allreport, section and blockfilters, and all sorts, areapplied.• You cannot apply sorts orfilters on formulas that use

Previous.• If Previous is applied on ameasure and the measurereturns an undefined value,Previous returns an undefinedvalue even if the previous linereturned a value.• Previous ignores breaks whenplaced outside a break headeror footer.• Previous returns the value inthe previous instance of thefooter when placed in a breakfooter.• Previous is reset in eachreport section.• When used in a crosstab,Previous does not treat the lastvalue in a row as the previousvalue of the first value of thenext row.

=Previous ([Sales]) – in a crosstab report.

Country 2012 Previous

2013 Previous

USA 2000 3000 2000UK 5000 6000 5000UAE 3000 5000 3000

=Previous([Sales]);2;NoNull)

Year Quarter Sales Previous2012 Q1 20002012 Q22012 Q3 1000 20002012 Q4 5000 20002013 Q1 10002013 Q2 50002013 Q3 5000 5000

Note: Above highlighted 2 means, previousfunction should start after 2 nd row of thetable.

Product Multiplies the values of ameasure.

NumProduct(measure)

=Product([Amount])

180 – If [Amount] hasthe values of 2,3,5,6

(2*3*5*6)PromptSummary

Returns the prompt text anduser response of all prompts ina document.

StringPromptSummary()

=PromptSummary()

*** Query Name:Query 1***

A.) Enter Current TimeID (YYYYMMDD)20131031

B.) Enter Prior Time ID(YYYYMMDD) 20130930

Quarter Quarter Number in a Date Int Quarter(date) =Quarter(CurrentDate())

4 – ConsideringCurrent Date as12/24/13

Query

Summary

Returns information about the

queries in a document.

string

QuerySummary([dp])

= QuerySummary()

*** Query Name:dp1 ***

** Query Properties:Universe:Index2Last Refresh Date:12/24/13 4:10 PMLast Execution Duration: 40Number of rows: 4,208Retrieve Duplicate Row: ON

** Query Definition:Result Objects: Calendar Date, Product Sales

Amount, Forecast Sales Amount, Country,Product Type


13/23

Filters (Time Id Equal 20,130,930)

Note: Multiple Data providers should useData Provider name in the Query Summaryor else it will return complete set of Dataprovider information

Rank Ranks a measure bydimensions.• The function uses the defaultcalculation context to calculatethe ranking if you do notspecify ranking dimensions.• You must always placedimensions in parentheseseven if there is only onedimension in the list of rankingor reset dimensions.• When you specify a set ofranking or reset dimensionsyou must separate them with

semi-colons.• By default the ranking is resetover a section or block break.

IntRank(measure;[ranking_dims][;Top|Bottom][;(reset_dims)])

ranking_dims - Thedimensions used torank the measure

Top | Bottom – Topis for DescendingOrder and Bottom isfor Ascending Order.

reset_dims - Thedimensions thatreset the ranking

=Ran([sales];([Country]))

Country Sales RankUSA 5,63,482 3UK 9,923,756 2UAE 10,458,691 1

=Ran([sales];([Country]);Bottom)The Bottom argument means that themeasures are ranked in descending order.

Country Sales RankUSA 5,63,482 1UK 9,923,756 2UAE 10,458,691 3

=Ran([sales]; ([Country];[Year]);([Country]))The rank is reset on the Country dimension.

Country Year Sales RankUSA FY2011Q1 2,000,000 1USA FY2011Q2 5,000,000 2USA FY2011Q4 6,000,000 3UK FY2012Q1 300,000 1UK FY2012Q2 5,600,000 2UK FY2012Q3 7,900,100 3UAE FY2013Q3 8,000,000 1

Ref Value Reference value of a reportobject when data tracking isactivated

Input_typeRefValue(obj)

= RefValue([Sales]) 500 - if the value ofthe [Sales] measure is500 in the referencedata.

Ref Value Date The date of the reference dataused for data tracking

Date RefValueDate() = RefValueDate() 12/24/13

Ref Value UserResponse

Response to a prompt whenthe reference data was thecurrent data.• The function returns anempty string if data tracking isnot activated.• You must enclose the nameof the data provider in squarebrackets.• You can use the DataProviderfunction to provide a referenceto a data provider.• If you selected more than one

StringRefValueUserResponse([dp;]prompt_string[;Index])

=RefValueUserResponse( "Enter CountryName” )

USA - if you entered"USA" in the "EnterCountry Name"prompt at the timewhen the referencedata was the currentdata.


14/23

value in answer to a prompt,the function returns a stringconsisting of a list of values (orprimary keys if the Indexoperator is specified) separatedby semi-colons.

Relative Date Date relative to another date.The num_days parameter can

be negative to return a dateearlier than start_date.

DateRelativeDate(start_d

ate;num_days)

=RelativeDate(CurrentDate();10)

1/3/14 – if the currentDate in 12/24/13

Relative Value Returns previous orsubsequent values of an object.• The object must be ameasure or a detail of adimension available in theblock.• The sort order of the list ofvalues of the slicing dimensionsis used to determine theoutput of the function.The sort order is determined bytwo factors: sorts applied tothe slicing dimensions, and theorder in which the slicingdimensions are listed in thefunction.• A dimension used as a sectionmaster can be specified as aslicing dimension.• All the slicing dimensionsmust be present in the block orsection header of the block inwhich the function is placed. Ifa slicing dimension is laterremoved from the block, thefunction returns the#COMPUTATION error.• If the offset exceeds thenumber of rows in the list ofvalues of the slicing dimension,the function returns null.• RelativeValue cannot be used

recursively.• You must always placedimensions in parentheseseven if there is only onedimension in the list of slicingdimensions.

Input_typeRelativeValue(measure|detail;slicing_dims;offset)

=RelativeValue([Sales];([Year]);-1)

Year Quarter Sales Rank2011 Q1 200,0002011 Q2 500,0002011 Q3 600,0002012 Q4 300,0002012 Q1 560,000 200,0002012 Q2 790,100 500,000

2012 Q3 800,000 600,0002012 Q4 850,00 300,000

Replace Replaces part of a string withanother string.

StringReplace(replace_in;replaced_string;replace_with)replace_in - The

=Replace("SAPBusinessOBJECTS";"OBJECTS";"Objects")

SAP Business Objects


15/23

string in which thetext is replacedreplaced_string - Thetext to be replacedreplace_with - Thetext that replacesreplaced_string

Report Filter Returns the Object information

in which report filters appliedto an object or report

String

ReportFilter(obj)

=ReportFilter([Cou

ntry])

United States – If filter

applied in the report /object where Country=”United States”

Report FilterSummary

Summary of the report filters ina document or report.If report_name is omitted,ReportFilterSummary returns asummary of all the reportfilters in all the reports (tabs) inthe document.

StringReportFilterSummary(report_name)

=ReportFilterSummary()

=ReportFilterSummary("Report 2"

*** Filter on ReportReport 1 ***

No Filter on Report 1*** Filter on ReportReport 2 ***No Filter on Report 2*** Filter on ReportReport 3 ***No Filter on Report 3

*** Filter on ReportReport 2 ***No Filter on Report 2

Report Name Returns Name of the report(Tab Name)

String ReportName() =ReportName Report 2 – Tab namewhere Report Namefunction is placed

Right Returns rightmost characters ofa string

StringRight(string;num_chars)

=Right("SAPBusinessObjects";7)

Objects – Rightmost 7Characters displayed.

Right pad Pads a string on its right withanother string.• If length is less than thelength of right_string andpadded_string combined,right_string is truncated.• If length is less than or equalto the length of padded_string,the function returnspadded_string.• If l ength is greater than thelengths of padded_string and

right_string combined,right_string is repeated orpartially repeated enoughtimes to fill out the length.

StringRightPad(padded_string;length;right_string)

=RightPad("SAP";6;"BO")

=RightPad("SAP";8;"BO")

SAP BO

SAP BOBO

Right Trim Trim the trailing spaces from astring

StringRightTrim(trimmed_string)

=RightTrim(“SAPBO “)

=RightTrim([Country])

SAP BO

USA – If [Country] hasvalues of “USA “.

Round Round a Number Num Round(number;round_level

=Round(123.45;1)=Round(123.45;-1)

123.5120


16/23

) =Round(1600;-3) 2000Row Index Row Number in a Table. Row

numbering starts at 0 andRowIndex returns#MULTIVALUE when placed ina table header or footer.

Integer RowIndex() =RowIndex() 0 – First row of thetable.

RunningAverage

Returns the running average ofa measure.

• You can use extended syntaxcontext operators withRunningAverage.• You can set the calculationdirection with the Row and Coloperators.• If you apply a sort on themeasure referenced byRunningAverage, the runningaverage is calculated after themeasure is sorted.• You must always placedimensions in parentheseseven if there is only onedimension in the list of resetdimensions.• When you specify a set ofreset dimensions you mustseparate them with semi-colons.• RunningAverage does notautomatically reset the averageafter a block break or newsection.

NumRunningAverage(mea

sure[;Row|Col][;IncludeEmpty][;(reset_dims)])

measure - AnymeasureRow|Col - Sets thecalculation directionIncludeEmpty -Includes emptyvalues in thecalculationreset_dims - Resetsthe calculation onthe specifieddimensions

=RunningAverage([Sales])

Country Region SalesRunningAverage

USA East 3568124 3568124USA West 300456 1934290UK North 8489381 4119320.3

=RunningAverage([Sales];([Country]))

Country Region SalesRunningAverage

USA East 3568124 3568124USA West 300456 1934290

UK North 8489381 8489381

Running Count The running count of a numberset.• You can use extended syntaxcontext operators withRunningCount.• You can set the calculationdirection with the Row and Coloperators.• If you apply a sort on themeasure referenced by

RunningCount, the runningcount is calculated after themeasure is sorted.• You must always placedimensions in parentheseseven if there is only onedimension in the list of resetdimensions.• When you specify a set ofreset dimensions you mustseparate them with semi-

NumRunningCount(dimension|measure[;Row|Col][;IncludeEmpty][;(reset_dims)])

measure - AnymeasureRow|Col - Sets thecalculation direction

IncludeEmpty -Includes emptyvalues in thecalculationreset_dims - Resetsthe calculation onthe specifieddimensions

=RunningCount([Sales])

Country Region SalesRunningCount

USA East 3568124 1USA West 300456 2UK North 8489381 3

=RunningCount([Sales];([Country]))

Country Region SalesRunningCount

USA East 3568124 1USA West 300456 2UK North 8489381 1


17/23

colons.• RunningCount does notautomatically reset the countafter a block break or newsection.

Running Max Running maximum of adimension or measure.• You can use extended syntax

context operators withRunningMax.• You can set the calculationdirection with the Row and Coloperators.• If you apply a sort on themeasure referenced byRunningMax, the runningmaximum is calculated afterthe measure is sorted.• You must always placedimensions in parentheseseven if there is only onedimension in the list of resetdimensions.• When you specify a set ofreset dimensions you mustseparate them with semi-colons.• RunningMax does notautomatically reset the maxafter a block break or newsection.

Input_typeRunningMax(dimension|measure[;Row|C

ol][;(reset_dims)])

measure - AnymeasureRow|Col - Sets thecalculation directionreset_dims - Resetsthe calculation onthe specifieddimensions

=RunningMax([Sales])

Country Region SalesRunningMax

USA East 3568124 3568124USA North 3000900 3568124USA West 300456 3568124UK North 8489381 8489381UK South 4561090 8489381

=RunningMax([Sales];([Country]))

Country Region SalesRunningMax


Running Min Running minimum of adimension or measure.• You can use extended syntaxcontext operators withRunningMin.• You can set the calculationdirection with the Row and Coloperators.• If you apply a sort on themeasure referenced byRunningMin, the running

minimum is calculated after themeasure is sorted.• You must always placedimensions in parentheseseven if there is only onedimension in the list of resetdimensions.• When you specify a set ofreset dimensions you mustseparate them with semi-colons.

Input_typeRunningMin(dimension|measure;[Row|Col];[(reset_dims)])

measure - AnymeasureRow|Col - Sets thecalculation directionreset_dims - Resetsthe calculation on

the specifieddimensions

=RunningMin([Sales])

Country Region SalesRunningMin

USA East 3568124 3568124USA North 3000900 3000900USA West 300456 300456 UK North 8489381 300456 UK South 4561090 300456

=RunningMin([Sales];([Country]))

Country Region SalesRunningMin



18/23

• RunningMin does notautomatically reset theminimum after a block break ornew section.

RunningProduct

Running product of a measure.• You can use extended syntaxcontext operators withRunningProduct.

• You can set the calculationdirection with the Row and Coloperators.• If you apply a sort on themeasure referenced byRunningProduct, the runningproduct is calculated after themeasure is sorted.• You must always placedimensions in parentheseseven if there is only onedimension in the list of resetdimensions.• When you specify a set ofreset dimensions you mustseparate them with semi-colons.• RunningProduct does notautomatically reset the productafter a block break or newsection.

Input_typeRunningProduct(dimension|measure;[Row|Col];[(reset_dims)]

)

measure - AnymeasureRow|Col - Sets thecalculation directionreset_dims - Resetsthe calculation onthe specifieddimensions

=RunningProduct([No. of Branch])

Country City

No. ofBranch

RunningProduct

USA LA 3 3USA SFO 5 15UK London 40 600

Running Sum Running product of a measure.• You can use extended syntaxcontext operators with theRunningSum.• You can set the calculationdirection with the Row and Coloperators.• If you apply a sort on themeasure referenced by theRunningSum function, therunning sum is calculated afterthe measure is sorted.

• You must always placedimensions in parentheseseven if there is only onedimension in the list of resetdimensions.• When you specify a set ofreset dimensions you mustseparate them with semi-colons.• RunningSum does notautomatically reset the sum

NumRunningProduct(measure[;Row|Col][;(reset_dims)])

measure - AnymeasureRow|Col - Sets thecalculation directionreset_dims - Resetsthe calculation onthe specified

dimensions

=RunningSum([Sales])

Country Region SalesRunningSum


=RunningSum([Sales];([Country]))

Country Region SalesRunningSum



19/23

after a block break or newsection.

Sign The sign of a number. Signreturns -1 if number isnegative, 0 if number is zeroand 1 if number is positive.

Int Sign(number) =Sign(23)=Sign(-31)=Sign(0)

1-10

Sin Returns the sine of an angle. Num Sin(angle) =Sin(1000)=Sin(-100)

0.830.51

Sqrt Square root of a number. Num Sqrt(number) =Sqrt(4) 16StdDev The standard deviation of a

measure.The standard deviation is ameasure of the statisticaldispersion in a set of numbers.It is calculatedby:• finding the average of the setof numbers• subtracting the average from

each number in the set andsquaring the difference• summing all these squareddifferences• dividing this sum by (numberof numbers in the set - 1)• finding the square root of theresult

NumStdDev(measure)

=StdDev([measure])

2.58 - If measure hasthe set of values (2, 4,6, 8).

StdDevP Population standard deviationof a measure.The population standarddeviation is a measure of thestatistical dispersion in a set ofnumbers. It iscalculated by:• finding the average of the setof numbers;• subtracting the average fromeach number in the set andsquaring the difference;• summing all these squareddifferences;• dividing this sum by (number

of numbers in the set);• finding the square root of theresult.You can use extended syntaxcontext operators withStdDevP.

NumStdDevP(measure)

=StdDev([measure])

2.24 - If measure hasthe set of values (2, 4,6, 8).

Substr Returns part of a string StringSubStr(string;start;length)

string - Any string

=Substr("SAPBusinessObjects";1;12)

=Substr("SAP

SAP Business

Objects


20/23

start - The startposition of theextracted stringlength - The length ofthe extracted string

BusinessObjects";14;7)

Sum The Sum of a Measure.• You can use extended syntaxcontext operators with Sum.

• If you include member_set,Sum returns the sum of themeasure for all members in themember set.• member_set can includemultiple sets separated bysemicolons (;).• The list of member sets mustbe enclosed in {}.• If the member set expressiondoes not specify a precisemember or node, the hierarchyreferencedmust be present in the table,then the member setexpression references thecurrent member in thehierarchy in the table. If thehierarchy is not in the table,the function returns themessage#MULTIVALUE.• Delegated measure

aggregation returns#TOREFRESH when therequired aggregation is notavailable in the query. The userhas to refresh the document toget the new level ofaggregation.This occurs for example whenusing the filter bar when theuser selects a value before “allvalues” and vice versa when

selecting “all values” before aselected value.• When migrating from XIR2 toXIR3, aggregation functionscontaining IN and WHEREclauses in XI2queries should be included intoSum function definitely byusing parenthesis as follows:In XIR2, the formula: =Sum([Measure] In ([Dim 1]) ) Where

NumSum(measure[;member_set])

=Sum([Sales]) Total Amount shouldbe returned.


21/23

([Dim 3]="Constant")should be expressed as:=Sum(([Salesrevenue]ForEach([Month]))Where([Month]=1))

Tan The tangent of an angle Num Tan(angle) =Tan(180) 1.34The TimeDim time dimensionallows you to build a time axis

from a date type universeobject. TimeDim returns thedata for the dates given as thefirst parameter over the timeperiods given as the secondparameter. When there areperiods that have no data, thefirst day of each empty periodis returned.This ensures a full axis for thegiven period. This guarantees:• That the axis retains thenatural time order (oldestobjects first, the most recentobjects last).• The axis contains all theperiods between the minimumand maximum dates in thecurrent context.

Use the above function inconjunction with the followingfunctions:• DayName • DayNumberOfMonth • DayNumberOfWeek • DayNumberOfYear • Month • MonthNumberOfYear• Quarter

TimeDim([Date];Period)

Date - The dateobject for the report,for example,InvoiceDate.Period - The periodfor the results, fromthe following values:• DayPeriod • MonthPeriod • QuarterPeriod • YearPeriod When no value isselected, theDayPeriod is used bydefault.This object should bea data providerobject, it must beavailable from reportobjects, and cannotbe a variable.

If we have data for Payment date as mentionbelow:

Payment Date Payment1/1/2013 50,000.001/8/2013 35,000.007/3/2013 70,000.00

Use the TimeDim([Payment Date]) in theabove table the axis value for Date will be fillthe Null also.

PaymentDate Payment TimeDim1/1/2013 50000 1/1/2013

1/2/20131/3/20131/4/20131/5/20131/6/20131/7/2013

1/8/2013 35000 1/8/20131/9/20131/10/20131/11/20131/12/2013Etc.,

To Date Turns a character string into adate. Give the date format asthe parameter to indicate toWeb Intelligence how to

convert the string into a date.The date format you providemust match the format of thedate in the original string. Referto the link below for thepossible date formats.

DateToDate(date_string;f ormat)

=ToDate("24/12/2013";"dd/MM/yyyy")

ToDate("24/12/13";"dd/MM/yy")

ToDate("24/12/13";"dd/MMMM/yy")

24/12/2013

24/12/13

24/DECEMBER/13

To Number Returns a string as a number. Ifstring is not a number,ToNumber returns #ERROR.

NumToNumber(string)

=ToNUmber(“5454”)

5454

Trim Trims the leading and trailingspaces from a string

String Trim(string) =Trim(“ SAP BO “) SAP BO


22/23

Truncate Truncates a number NumTruncate(number;truncate_level)

=Truncate(1400;-3) 1000

The functionrounds/truncates tothe nearest 10(parameter = -1), 100(parameter= -2), 1000 (parameter

= -3) and so on.Unique NameOf

Returns the unique name of anobject

StringUniqueNameOf(obj)

=UniqueNameOf([Payment Date])

Payment Date

UniverseName

The name of the universe onwhich a data provider is based

StringUniverseName(dp)

=UniverseName([Q uery 1])

Payment – This wasthe Name of auniverse.

Upper Converts a String to Upper Case String Upper(string) =Upper(”sap”) SAPUrl Encode Applies URL encoding rules to a

stringStringUrlEncode(html)

=URLEncode("http://www.google.com")

http%3A%2F%2Fwww%2Egoogle%2Ecom

User Response Returns the response to a

prompt.• You must enclose the nameof the data provider in squarebrackets.• You can use the DataProvider function to provide a referenceto a data provider.• If you select more than onevalue in answer to a prompt,the function returns a stringconsisting of a list of values (orprimary keys if the Indexoperator is specified) separatedby semi-colons.

String

UserResponse([dp;]prompt_string[;Index])

dp - The dataproviderprompt_string - Theprompt textIndex - Tells thefunction to returnthe database primarykeys of the promptvalues

=UserResponse(“En

ter CountryName”)

USA – If you entered

USA in the Prompt

Var The Variance of a Measure.The variance is a measure ofthe statistical dispersion in aset of numbers. It is calculatedby:• finding the average of the setof numbers• subtracting the average fromeach number in the set and

squaring the difference• summing all these squareddifferences• dividing this sum by (numberof numbers in the set - 1)The variance is the square ofthe standard deviation.You can use extended syntaxcontext operators with Var.

Num Var(measure) =Var([Sales]) 6.67 - If Sales has theset of values (2, 4, 6,8)

VarP Population variance of ameasure.

Num VarP(measure) =VarP([Sales]) 5 - If Sales has the setof values (2, 4, 6, 8)


23/23

The population variance is ameasure of the statisticaldispersion in a set of numbers.It is calculatedby:• finding the average of the setof numbers• subtracting the average from

each number in the set andsquaring the difference• summing all these squareddifferences• dividing this sum by (numberof numbers in the set)The population variance is thesquare of the populationstandard deviation.You can use extended syntaxcontext operators with VarP.

Week Week Number of the Date Int Week(date) =Week(CurrentDate())

2 – Current Date12/24/13 and Startweek is for Monday

Word Cap Capitalizes the first letter of allthe words in a string

StringWordCap(string)

=WordCap(“Payment due for june”)

Payment Due For June

Year Year in a date Int Year(date) =Year(CurrentDate())

2013

webi report function overview

Documents