MicroStrategy 9 Functions User Manual
Below you will find brief information for MicroStrategy Functions 9. This document explores the basic building blocks of MicroStrategy objects, including the various types of functions, their syntax, and how to use them in expressions to create reports, analyses, and other data visualizations. It also explains the different types of function processing and how the Intelligence Server evaluates formulas. It provides detailed descriptions of all the functions available in MicroStrategy. The information is organized by function type, including basic mathematical operations, date and time manipulations, string formatting, and specialized functions for data mining, forecasting, and statistical analysis with practical examples illustrating the use of each function. This documentation is key in understanding the power and flexibility of MicroStrategy functions.
Advertisement
Advertisement
MicroStrategy Functions
Reference
Version: 9.3
Document Number: 09410930
Twenty-sixth Edition, version 9.3
To ensure that you are using the documentation that corresponds to the software you are licensed to use, compare this version number with the software version shown in “About MicroStrategy...” in the Help menu of your software.
Document number: 09410930
Copyright © 2012 by MicroStrategy Incorporated. All rights reserved.
If you have not executed a written or electronic agreement with MicroStrategy or any authorized MicroStrategy distributor, the following terms apply:
This software and documentation are the proprietary and confidential information of MicroStrategy Incorporated and may not be provided to any other person. Copyright © 2001-2012 by MicroStrategy Incorporated. All rights reserved.
THIS SOFTWARE AND DOCUMENTATION ARE PROVIDED “AS IS” AND WITHOUT EXPRESS OR LIMITED WARRANTY OF ANY KIND BY EITHER
MICROSTRATEGY INCORPORATED OR ANYONE WHO HAS BEEN INVOLVED IN THE CREATION, PRODUCTION, OR DISTRIBUTION OF THE
SOFTWARE OR DOCUMENTATION, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE, GOOD TITLE AND NONINFRINGMENT, QUALITY OR ACCURACY. THE ENTIRE RISK AS TO THE QUALITY AND
PERFORMANCE OF THE SOFTWARE AND DOCUMENTATION IS WITH YOU. SHOULD THE SOFTWARE OR DOCUMENTATION PROVE
DEFECTIVE, YOU (AND NOT MICROSTRATEGY, INC. OR ANYONE ELSE WHO HAS BEEN INVOLVED WITH THE CREATION, PRODUCTION, OR
DISTRIBUTION OF THE SOFTWARE OR DOCUMENTATION) ASSUME THE ENTIRE COST OF ALL NECESSARY SERVICING, REPAIR, OR
CORRECTION. SOME STATES DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO THE ABOVE EXCLUSION MAY NOT APPLY TO
YOU.
In no event will MicroStrategy, Inc. or any other person involved with the creation, production, or distribution of the Software be liable to you on account of any claim for damage, including any lost profits, lost savings, or other special, incidental, consequential, or exemplary damages, including but not limited to any damages assessed against or paid by you to any third party, arising from the use, inability to use, quality, or performance of such Software and
Documentation, even if MicroStrategy, Inc. or any such other person or entity has been advised of the possibility of such damages, or for the claim by any other party. In addition, MicroStrategy, Inc. or any other person involved in the creation, production, or distribution of the Software shall not be liable for any claim by you or any other party for damages arising from the use, inability to use, quality, or performance of such Software and Documentation, based upon principles of contract warranty, negligence, strict liability for the negligence of indemnity or contribution, the failure of any remedy to achieve its essential purpose, or otherwise. The entire liability of MicroStrategy, Inc. and your exclusive remedy shall not exceed, at the option of MicroStrategy, Inc., either a full refund of the price paid, or replacement of the Software. No oral or written information given out expands the liability of MicroStrategy, Inc. beyond that specified in the above limitation of liability. Some states do not allow the limitation or exclusion of liability for incidental or consequential damages, so the above limitation may not apply to you.
The information contained in this manual (the Documentation) and the Software are copyrighted and all rights are reserved by MicroStrategy, Inc.
MicroStrategy, Inc. reserves the right to make periodic modifications to the Software or the Documentation without obligation to notify any person or entity of such revision. Copying, duplicating, selling, or otherwise distributing any part of the Software or Documentation without prior written consent of an authorized representative of MicroStrategy, Inc. are prohibited. U.S. Government Restricted Rights. It is acknowledged that the Software and
Documentation were developed at private expense, that no part is public domain, and that the Software and Documentation are Commercial Computer
Software provided with RESTRICTED RIGHTS under Federal Acquisition Regulations and agency supplements to them. Use, duplication, or disclosure by the U.S. Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at
DFAR 252.227-7013 et. seq. or subparagraphs (c)(1) and (2) of the Commercial Computer Software—Restricted Rights at FAR 52.227-19, as applicable.
Contractor is MicroStrategy, Inc., 1850 Towers Crescent Plaza, Tysons Corner, VA 22182. Rights are reserved under copyright laws of the United States with respect to unpublished portions of the Software.
The following are either trademarks or registered trademarks of MicroStrategy Incorporated in the United States and certain other countries:
MicroStrategy, MicroStrategy 6, MicroStrategy 7, MicroStrategy 7i, MicroStrategy 7i Evaluation Edition, MicroStrategy 7i Olap Services, MicroStrategy 8,
MicroStrategy 9, MicroStrategy Distribution Services, MicroStrategy MultiSource Option, MicroStrategy Command Manager, MicroStrategy Enterprise
Manager, MicroStrategy Object Manager, MicroStrategy Reporting Suite, MicroStrategy Power User, MicroStrategy Analyst, MicroStrategy Consumer,
MicroStrategy Email Delivery, MicroStrategy BI Author, MicroStrategy BI Modeler, MicroStrategy Evaluation Edition, MicroStrategy Administrator,
MicroStrategy Agent, MicroStrategy Architect, MicroStrategy BI Developer Kit, MicroStrategy Broadcast Server, MicroStrategy Broadcaster,
MicroStrategy Broadcaster Server, MicroStrategy Business Intelligence Platform, MicroStrategy Consulting, MicroStrategy CRM Applications,
MicroStrategy Customer Analyzer, MicroStrategy Desktop, MicroStrategy Desktop Analyst, MicroStrategy Desktop Designer, MicroStrategy eCRM 7,
MicroStrategy Education, MicroStrategy eTrainer, MicroStrategy Executive, MicroStrategy Infocenter, MicroStrategy Intelligence Server, MicroStrategy
Intelligence Server Universal Edition, MicroStrategy MDX Adapter, MicroStrategy Narrowcast Server, MicroStrategy Objects, MicroStrategy OLAP
Provider, MicroStrategy SDK, MicroStrategy Support, MicroStrategy Telecaster, MicroStrategy Transactor, MicroStrategy Web, MicroStrategy Web
Business Analyzer, MicroStrategy World, Application Development and Sophisticated Analysis, Best In Business Intelligence, Centralized Application
Management, Information Like Water, Intelligence Through Every Phone, Intelligence To Every Decision Maker, Intelligent E-Business, Personalized
Intelligence Portal, Query Tone, Rapid Application Development, MicroStrategy Intelligent Cubes, The Foundation For Intelligent E-Business, The
Integrated Business Intelligence Platform Built For The Enterprise, The Platform For Intelligent E-Business, The Scalable Business Intelligence Platform
Built For The Internet, Office Intelligence, MicroStrategy Office, MicroStrategy Report Services, MicroStrategy Web MMT, MicroStrategy Web Services,
Pixel Perfect, Pixel-Perfect, MicroStrategy Mobile, MicroStrategy Integrity Manager and MicroStrategy Data Mining Services are all registered trademarks or trademarks of MicroStrategy Incorporated.
All other company and product names may be trademarks of the respective companies with which they are associated. Specifications subject to change without notice. MicroStrategy is not responsible for errors or omissions. MicroStrategy makes no warranties or commitments concerning the availability of future products or versions that may be planned or under development.
Patent Information
This product is patented. One or more of the following patents may apply to the product sold herein: U.S. Patent Nos. 6,154,766, 6,173,310, 6,260,050,
6,263,051, 6,269,393, 6,279,033, 6,567,796, 6,587,547, 6,606,596, 6,658,093, 6,658,432, 6,662,195, 6,671,715, 6,691,100, 6,694,316, 6,697,808,
6,704,723, 6,741,980, 6,765,997, 6,768,788, 6,772,137, 6,788,768, 6,798,867, 6,801,910, 6,820,073, 6,829,334, 6,836,537, 6,850,603, 6,859,798,
6,873,693, 6,885,734, 6,940,953, 6,964,012, 6,977,992, 6,996,568, 6,996,569, 7,003,512, 7,010,518, 7,016,480, 7,020,251, 7,039,165, 7,082,422,
7,113,993, 7,127,403, 7,174,349, 7,181,417, 7,194,457, 7,197,461, 7,228,303, 7,260,577, 7,266,181, 7,272,212, 7,302,639, 7,324,942, 7,330,847,
7,340,040, 7,356,758, 7,356,840, 7,415,438, 7,428,302, 7,430,562, 7,440,898, 7,486,780, 7,509,671, 7,516,181, 7,559,048, 7,574,376, 7,617,201,
7,725,811, 7,801,967, 7,836,178, 7,861,161, 7,861,253, 7,881,443, 7,925,616, 7,945,584, 7,970,782, 8,005,870, 8,051,168, 8,051,369, 8,094,788, and
8,130,918. Other patent applications are pending.
Various MicroStrategy products contain the copyrighted technology of third parties. This product may contain one or more of the following copyrighted technologies:
Graph Generation Engine Copyright © 1998-2012. Three D Graphics, Inc. All rights reserved.
Actuate® Formula One. Copyright © 1993-2012 Actuate Corporation. All rights reserved.
XML parser Copyright © 2003-2012 Microsoft Corporation. All rights reserved.
Xalan XSLT processor. Copyright © 1999-2012. The Apache Software Foundation. All rights reserved.
Xerces XML parser. Copyright © 1999-2012. The Apache Software Foundation. All rights reserved.
FOP XSL formatting objects. Copyright © 2004-2012. The Apache Software Foundation. All rights reserved.
Portions of Intelligence Server memory management Copyright © 1991-2012 Compuware Corporation. All rights reserved.
ASIHTTPRequest library. Copyright © 2007-2012, All-Seeing Interactive. All rights reserved.
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. (http://www.openssl.org/)
International Components for Unicode
Copyright © 1999-2012 Compaq Computer Corporation
Copyright © 1999-2012 Hewlett-Packard Company
Copyright © 1999-2012 IBM Corporation
Copyright © 1999-2012 Hummingbird Communications Ltd.
Copyright © 1999-2012 Silicon Graphics, Inc.
Copyright © 1999-2012 Sun Microsystems, Inc.
Copyright © 1999-2012 The Open Group
All rights reserved.
Real Player and RealJukebox are included under license from Real Networks, Inc. Copyright © 1999-2012. All rights reserved.
C
ONTENTS
Description of this guide........................................................... xv
About this book .............................................................................xv
Additional formats ................................................................. xvii
How to find business scenarios and examples .................... xviii
What’s new in this guide ...................................................... xviii
Prerequisites ..........................................................................xix
Who should use this guide.....................................................xix
Resources.....................................................................................xx
Documentation........................................................................xx
Education............................................................................xxviii
Consulting............................................................................ xxix
International support ............................................................ xxix
Technical Support.................................................................xxx
Feedback .................................................................................. xxxv
© 2012 MicroStrategy, Inc.
Introduction.................................................................................. 1
Function syntax and formula components ..................................... 4
Function types ......................................................................... 5
Function parameters .............................................................. 17
Arguments ............................................................................. 25
Using functions in expressions .................................................... 27
Metric expressions ................................................................. 27
Attribute form expressions ..................................................... 34
Consolidation element expressions ....................................... 37
Custom Group expressions ................................................... 38
v
Contents MicroStrategy Functions Reference
Fact expressions.................................................................... 40
Filter expressions................................................................... 42
Subtotal expressions ............................................................. 43
Transformation expressions................................................... 44
Adding functions to expressions with the Insert Function
Wizard.................................................................................... 45
How MicroStrategy processes functions...................................... 48
Types of function processing ................................................. 48
How Intelligence Server uses functions ................................. 49
Using group-value functions .................................................. 49
Using single-value functions .................................................. 53
Using OLAP functions............................................................ 56
Using custom plug-in functions .............................................. 64
Additional examples of functions in expressions ......................... 68
Hypothesis Testing example.................................................. 68
Confidence level example...................................................... 75
Statistical descriptors - Simple example ................................ 87
Forecasting example ............................................................. 91
Basic functions............................................................................. 98
Add ........................................................................................ 98
Average ................................................................................. 99
Avg (average) ...................................................................... 100
Count ................................................................................... 101
First...................................................................................... 104
GeoMean (geometric mean)................................................ 105
Greatest ............................................................................... 106
Last ...................................................................................... 107
Least .................................................................................... 108
Max (maximum) ................................................................... 109
Median ................................................................................. 111
Min (minimum) ..................................................................... 112
Mode.................................................................................... 114
Multiply................................................................................. 115
Product ................................................................................ 116
StDevP (standard deviation of a population) ....................... 117
StDev (standard deviation of a sample)............................... 118
Sum ..................................................................................... 120
VarP (variance of a population) ........................................... 121
Var (variance of a sample)................................................... 123
vi
© 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Contents
Date and time functions ............................................................. 124
AddDays .............................................................................. 124
AddMonths........................................................................... 125
CurrentDate ......................................................................... 126
CurrentDateTime ................................................................. 126
CurrentTime ......................................................................... 127
Date ..................................................................................... 127
DayofMonth ......................................................................... 127
DayofWeek .......................................................................... 128
DayofYear............................................................................ 129
DaysBetween....................................................................... 129
Hour ..................................................................................... 130
Millisecond ........................................................................... 130
Minute .................................................................................. 131
Month................................................................................... 131
MonthEndDate..................................................................... 132
MonthStartDate.................................................................... 132
MonthsBetween ................................................................... 133
Quarter................................................................................. 134
Second................................................................................. 134
Week.................................................................................... 135
Year ..................................................................................... 135
YearEndDate ....................................................................... 136
YearStartDate ...................................................................... 136
Internal functions ....................................................................... 137
Apply (Pass-Through) functions........................................... 138
Banding functions ................................................................ 143
Case functions ..................................................................... 149
NULL/Zero functions.................................................................. 154
IsNotNull .............................................................................. 154
IsNull.................................................................................... 155
NullToZero ........................................................................... 155
ZeroToNull ........................................................................... 156
OLAP functions.......................................................................... 156
ExpWghMovingAvg (exponential weighted moving
average)............................................................................... 157
ExpWghRunningAvg (exponential weighted running
average)............................................................................... 161
FirstInRange ........................................................................ 163
Lag....................................................................................... 164
LastInRange ........................................................................ 169
Lead..................................................................................... 170
© 2012 MicroStrategy, Inc.
vii
Contents
viii
MicroStrategy Functions Reference
MovingAvg (moving average) .............................................. 172
MovingCount........................................................................ 174
MovingDifference................................................................. 176
MovingMax (moving maximum) ........................................... 177
MovingMin (moving minimum) ............................................. 178
MovingStDevP (moving standard deviation of a
population) ........................................................................... 180
MovingStDev (moving standard deviation) .......................... 181
MovingSum .......................................................................... 183
OLAPAvg (OLAP average) .................................................. 184
OLAPCount.......................................................................... 187
OLAPMax (OLAP maximum) ............................................... 191
OLAPMin (OLAP minimum) ................................................. 194
OLAPRank ........................................................................... 197
OLAPSum ............................................................................ 199
RunningAvg (running average) ............................................ 202
RunningCount...................................................................... 203
RunningMax (running maximum)......................................... 204
RunningMin (running minimum)........................................... 205
RunningStDevP (running standard deviation of a
population) ........................................................................... 206
RunningStDev (running standard deviation) ........................ 208
RunningSum ........................................................................ 209
Rank and NTile functions........................................................... 211
NTile .................................................................................... 212
NTileSize ............................................................................. 214
NTileValue ........................................................................... 216
NTileValueSize .................................................................... 224
Percentile............................................................................. 226
Rank .................................................................................... 227
String functions .......................................................................... 231
Concat (concatenate) .......................................................... 232
ConcatBlank (concatenate plus blank space)...................... 233
InitCap (initial capitalization) ................................................ 234
LeftStr (left string selection) ................................................. 235
Length (length of string)....................................................... 236
Lower (lower case)............................................................... 237
LTrim (left trim)..................................................................... 238
Position (position of substring)............................................. 239
RightStr (right string selection)............................................. 239
RTrim (right trim).................................................................. 240
SubStr (substring selection)................................................. 241
© 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Contents
Trim...................................................................................... 242
Upper (upper case) .............................................................. 243
Arithmetic operators................................................................... 246
Minus (-)............................................................................... 246
Times (*) .............................................................................. 246
Divide (/) .............................................................................. 247
Plus (+) ................................................................................ 247
Unary minus (U-).................................................................. 248
Comparison operators ............................................................... 248
Less than (<)........................................................................ 249
Less than or equal (<=)........................................................ 249
Not equal (<>)...................................................................... 250
Equal (=) .............................................................................. 250
Greater (>) ........................................................................... 251
Greater than or equal (>=) ................................................... 251
Begins with .......................................................................... 252
Between............................................................................... 253
Contains............................................................................... 253
Ends with ............................................................................. 254
In.......................................................................................... 254
Like ...................................................................................... 255
Not begins with .................................................................... 256
Not between......................................................................... 256
Not contains ......................................................................... 257
Not ends with ....................................................................... 257
Not in ................................................................................... 258
Not like................................................................................. 258
Comparison for rank operators .................................................. 259
Less than or equal enhanced (*<=) ..................................... 259
Not equal enhanced (*<>).................................................... 260
Equal enhanced (*=) ............................................................ 261
Greater than or equal enhanced (*>=)................................. 261
Between enhanced (*Between) ........................................... 262
Not between enhanced (Not *Between)............................... 263
Logical operators ....................................................................... 264
And ...................................................................................... 264
IF.......................................................................................... 264
Not ....................................................................................... 265
Or......................................................................................... 266
© 2012 MicroStrategy, Inc.
ix
Contents
x
MicroStrategy Functions Reference
Introduction.............................................................................. 267
Data mining functions ................................................................ 268
Financial functions ..................................................................... 269
Accrint (accrued interest) ..................................................... 269
Accrintm (accrued interest at maturity) ................................ 271
Coupdaybs (coupon period, beginning to settlement) ......... 273
Coupdays (coupon period, number of days with
settlement) ........................................................................... 274
Coupdaysnc (coupon period, settlement to next coupon).... 275
Coupncd (next date after settlement)................................... 276
Coupnum (coupon, number payable between settlement
and maturity) ........................................................................ 278
Couppcd (coupon date, previous)........................................ 279
Cumipmt (cumulative interest paid) ..................................... 280
Cumprinc (cumulative principal paid)................................... 281
Db (fixed-declining balance (asset depreciation))................ 283
Ddb (double-declining balance (asset depreciation))........... 283
Disc (discount rate for a security) ........................................ 284
Dollarde (dollar price, converted from fraction to decimal) .. 285
Dollarfr (dollar price, converted from decimal to fraction) .... 286
Duration ............................................................................... 286
Effect (effective annual interest rate) ................................... 288
Fv (future value)................................................................... 289
Fvschedule (future value schedule)..................................... 289
Intrate (interest rate) ............................................................ 290
Ipmt (interest payment)........................................................ 291
IRR (internal rate of return).................................................. 292
Mduration (modified duration) .............................................. 293
MIRR (modified internal rate of return) ................................ 295
Nominal (nominal annual interest rate) ................................ 296
Nper (number of investment periods) .................................. 297
NPV (net present value of an investment) ........................... 297
Oddfprice (odd-first-period price) ......................................... 299
Oddfyield (odd-first-period yield).......................................... 301
Oddlprice (odd-last-period price) ......................................... 302
Oddlyield (odd-last-period yield) .......................................... 304
Pmt (payment) ..................................................................... 306
Ppmt (principal payment) ..................................................... 307
Price (price per $100 face value) ......................................... 307
Pricedisc (price, discounted)................................................ 309
Pricemat (price at maturity).................................................. 310
Pv (present value)................................................................ 312
Rate (interest rate per period).............................................. 313
© 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Contents
Received (amount received at maturity) .............................. 313
Sln (straight-line depreciation) ............................................. 315
Syd (sum of year’s digits depreciation) ................................ 315
Tbilleq (T-bill equity)............................................................. 316
Tbillprice (T-bill price)........................................................... 317
Tbillyield (T-bill yield) ........................................................... 318
Vdb (variable declining balance).......................................... 319
Yield..................................................................................... 319
Yielddisc (yield on a discounted security) ............................ 321
Yieldmat (yield at maturity) .................................................. 322
Mathematical functions .............................................................. 323
Abs (absolute value) ............................................................ 324
Acos (arc cosine) ................................................................. 324
Acosh (arc cosine, hyperbolic)............................................. 325
Asin (arc sine)...................................................................... 325
Asinh (arc sine, hyperbolic).................................................. 325
Atan (arc tangent) ................................................................ 326
Atan2 (arc tangent 2) ........................................................... 326
Atanh (arc tangent, hyperbolic)............................................ 327
Ceiling (ceiling value)........................................................... 327
Combine (combination)........................................................ 328
Cos (cosine)......................................................................... 329
Cosh (cosine, hyperbolic) .................................................... 329
Degrees (conversion to)....................................................... 330
Exp (exponent) .................................................................... 331
Factorial (factorial) ............................................................... 331
Floor (floor value)................................................................. 332
Int (integer) .......................................................................... 333
Ln (logarithm, natural).......................................................... 334
Log (logarithm)..................................................................... 334
Log10 (logarithm, base 10).................................................. 335
Mod (modulus)..................................................................... 335
Power................................................................................... 336
Quotient ............................................................................... 337
Radians (conversion to) ....................................................... 338
Randbetween (random number between two values) ......... 338
Round (round to nearest integer)......................................... 340
Round2 (round to specified precision) ................................. 341
Sin (sine).............................................................................. 341
Sinh (sine, hyperbolic) ......................................................... 342
Sqrt (square root)................................................................. 342
Tan (tangent) ....................................................................... 343
© 2012 MicroStrategy, Inc.
xi
Contents
xii
MicroStrategy Functions Reference
Tanh (tangent, hyperbolic) ................................................... 344
Trunc (truncate) ................................................................... 344
Statistical functions .................................................................... 345
AvgDev (average deviation)................................................. 345
BetaDistribution ................................................................... 346
BinomialDistribution ............................................................. 347
ChiSquareDistribution.......................................................... 348
ChiSquareTest (chi-square test for goodness of fit) ............ 349
Confidence (confidence interval) ......................................... 350
Correlation ........................................................................... 351
Covariance........................................................................... 352
CritBinomial (criterion binomial) ........................................... 353
ExponentialDistribution ........................................................ 354
Fisher (fisher transformation)............................................... 355
FDistribution (f-probability distribution) ................................ 356
Forecast............................................................................... 356
ForecastV (forecast, vector input)........................................ 358
FTest.................................................................................... 360
GammaDistribution .............................................................. 361
Growth ................................................................................. 362
GrowthV (growth, vector input) ............................................ 363
HeteroscedasticTTest and HomoscedasticTTest ................ 365
HypergeometricDistribution.................................................. 366
Intercept............................................................................... 367
InverseBetaDistribution (inverse of the beta distribution) .... 368
InverseChiDistribution (inverse of chi-squared
distribution) .......................................................................... 369
InverseFisher (inverse of the Fisher transformation) ........... 370
InverseFDistribution (inverse of F-probability distribution)... 371
InverseGammaDistribution (inverse of gamma
distribution) .......................................................................... 371
InverseLognormalDistribution (inverse of lognormal
distribution) .......................................................................... 372
InverseTDistribution (inverse of T-distribution) .................... 374
Kurtosis................................................................................ 375
LognormalDistribution.......................................................... 376
MeanTTest (mean T-test) .................................................... 377
NegativeBinomialDistribution ............................................... 378
NormalDistribution (normal cumulative distribution) ............ 379
© 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Contents
PairedTTest (paired T-test, two-sample for means) ............ 380
Pearson (Pearson product moment correlation
coefficient) ........................................................................... 381
Permut (permutation)........................................................... 382
PoissonDistribution .............................................................. 382
Skew .................................................................................... 384
Slope (of a linear regression)............................................... 385
Standardize.......................................................................... 386
SteYX (standard error of estimates) .................................... 387
TDistribution......................................................................... 388
Trend ................................................................................... 388
TrendV (trend, vector input)................................................. 389
VarTest (variance test)......................................................... 392
WeibullDistribution ............................................................... 393
Introduction.............................................................................. 395
Analytical Engine support for functions...................................... 395
Databases that a function can be evaluated on......................... 398
Aster nCluster ...................................................................... 400
EXASolution......................................................................... 403
Greenplum ........................................................................... 407
Hadoop Hive ........................................................................ 410
IBM DB2 .............................................................................. 412
Infobright.............................................................................. 430
Informix ................................................................................ 433
Microsoft Access.................................................................. 439
Microsoft SQL Server........................................................... 445
MySQL................................................................................. 461
Netezza................................................................................ 464
Oracle .................................................................................. 473
ParAccel .............................................................................. 490
PostgreSQL ......................................................................... 497
Red Brick ............................................................................. 504
Salesforce.com .................................................................... 507
SAND CDBMS..................................................................... 509
Sybase................................................................................. 512
Teradata .............................................................................. 531
Vertica.................................................................................. 548
© 2012 MicroStrategy, Inc.
xiii
Contents MicroStrategy Functions Reference
xiv
© 2012 MicroStrategy, Inc.
B
OOK
O
VERVIEW AND
A
DDITIONAL
R
ESOURCES
Description of this guide
Functions in MicroStrategy are powerful tools used in expressions to define
MicroStrategy objects and initiate complex user-selected calculations.
Wherever you can define an expression, you can use a function. From creating basic objects to building complex reports and analyzing data, you have the ability to create custom expressions using a large library of functions supported by MicroStrategy. Although functions are most commonly used in metric expressions, they are also used to create filters, define attribute forms, and so on.
About this book
This guide provides the following information:
•
Details of function syntax and the components of a function formula
•
Explanation of where functions can be used in expressions
•
Steps to access functions from MicroStrategy Desktop
© 2012 MicroStrategy, Inc.
About this book
xv
Book Overview and Additional Resources MicroStrategy Functions Reference
•
Overview of the MicroStrategy engine and how Intelligence Server uses functions
•
Examples of functions used in complex business scenarios
•
Details of function support in certified databases
This guide does not include information on Data Mining functions.
This information can be found in the Data Mining Services chapter of the MicroStrategy Advanced Reporting Guide.
These details are described in the following chapters of the guide:
•
Chapter 1, Understanding Functions in MicroStrategy
•
•
•
Chapter 4, Plug-In Package Functions
•
Appendix A, MicroStrategy and Database Support for Functions
Function categories
For the purposes of this guide, functions have been organized into the following categories:
•
Date and time functions, page 124
Rank and NTile functions, page 211
•
Arithmetic operators, page 246
Comparison operators, page 248
xvi
About this book © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Book Overview and Additional Resources
Comparison for rank operators, page 259
•
Chapter 4, Plug-In Package Functions
Data mining functions, page 268
Mathematical functions, page 323
Statistical functions, page 345
Function descriptions
For every function identified, the description includes:
•
Information returned
•
Function syntax
•
Expression representative of the function (as applicable)
•
Notes regarding restrictions or conditions on execution and use (as applicable)
•
Examples of the function in reports or through simple descriptions
The following sections provide the location of additional examples, list prerequisites for using this book, and describe the user roles the information in this book was designed for.
Dates in the MicroStrategy Tutorial project are updated to reflect the current year. The sample documents and images in this guide, as well as the procedures, were created with dates that may no longer be available in the Tutorial project. Replace them with the first year of data in your Tutorial project.
Additional formats
This book is also available as an electronic publication in the Apple iBookstore, and can be read on an iPhone or iPad with the iBooks app
About this book
xvii
© 2012 MicroStrategy, Inc.
Book Overview and Additional Resources MicroStrategy Functions Reference installed. To download this book, search for the book’s title in the iBookstore search bar, or scan the QR code below using your device's camera.
How to find business scenarios and examples
Within this guide, each function is accompanied by an example, as well as some usage guidelines. The first chapter includes additional examples that involve several functions in business use cases.
For examples of reporting functionality, see the MicroStrategy Tutorial, which is MicroStrategy’s sample warehouse, metadata, and project.
Information about the MicroStrategy Tutorial can be found in the
MicroStrategy Basic Reporting Guide.
Detailed examples of advanced reporting functionality can be found in the
MicroStrategy Advanced Reporting Guide.
Other examples in this book use the Analytics Modules, which include a set of precreated sample reports, each from a different business area. Sample reports present data for analysis in such business areas as financial reporting, human resources, and customer analysis.
What’s new in this guide
MicroStrategy 9.3
•
Additional examples of BreakBy and SortBy parameters are provided in
BreakBy and SortBy parameters, page 19
.
•
Additional information on how to use prompts to provide the value for an argument in a function is provided in
Using prompts for arguments, page 25
•
Examples of using functions have been updated to reflect enhancements and updates available in the Tutorial project, which can help act as a
xviii
About this book © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Book Overview and Additional Resources guided tutorial on using various functions. These updated examples are
Additional examples of functions in expressions, page 68
.
•
An additional example of using the ExpWghMovingAvg function, utilizing the Human Resources Analysis Module project, is provided in
ExpWghMovingAvg (exponential weighted moving average), page 157
•
An additional example of using the MovingAvg function, utilizing the
Human Resources Analysis Module project, is provided in
.
•
Function support for databases has been updated in
Databases that a function can be evaluated on, page 398
Prerequisites
Before reading this document, you should be familiar with:
•
Basic MicroStrategy terminology like metrics, facts, attributes, and so on.
This information is found in the Basic Reporting Guide.
•
Additional MicroStrategy object knowledge such as custom groups. This information is found in the Advanced Reporting Guide.
•
Standard mathematical function notation.
Who should use this guide
This document is designed for any user who needs to create an expression using any of the predefined functions MicroStrategy offers.
© 2012 MicroStrategy, Inc.
About this book
xix
Book Overview and Additional Resources
Resources
MicroStrategy Functions Reference
Documentation
MicroStrategy provides both manuals and online help; these two information sources provide different types of information, as described below:
• Manuals
: In general, MicroStrategy manuals provide:
Introductory information and concepts
Examples and images
Checklists and high-level procedures to get started
The steps to access the manuals are described in
Accessing manuals and other documentation sources, page xxvi
.
Most of these manuals are also available printed in a bound, soft cover format. To purchase printed manuals, contact your MicroStrategy
Account Executive with a purchase order number.
• Help
: In general, MicroStrategy help provides:
Detailed steps to perform procedures
Descriptions of each option on every software screen
For the most up-to-date translations of MicroStrategy documentation, refer to the MicroStrategy Knowledge Base. Due to translation time, manuals in languages other than English may contain information that is one or more releases behind. You can see the version number on the title page of each manual.
MicroStrategy overview and evaluation
•
Introduction to MicroStrategy: Evaluation Guide
Instructions for installing, configuring, and using the MicroStrategy
Evaluation Edition of the software. This guide also includes a detailed, step-by-step evaluation process of MicroStrategy features, where you perform reporting with the MicroStrategy Tutorial project and its sample business data.
xx
Resources © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Book Overview and Additional Resources
•
MicroStrategy Evaluation Edition Quick Start Guide
Overview of the installation and evaluation process, and additional resources.
•
Evaluate MicroStrategy for Linux Guide: In a Windows or Linux
Environment with the MicroStrategy Evaluation Edition Virtual
Appliance
Evaluate MicroStrategy for Linux, in a Microsoft Windows or Linux environment, with the MicroStrategy Evaluation Edition Virtual
Appliance. This guide provides all details to download, activate, and evaluate MicroStrategy software running in a Linux environment.
•
MicroStrategy Reporting Suite: Quick Start Guide
Evaluate MicroStrategy as a departmental solution. Provides detailed information to download, install, configure, and use the MicroStrategy
Reporting Suite.
•
MicroStrategy Mobile Suite: Quick Start Guide
Evaluate MicroStrategy Mobile as a departmental solution. Provides detailed information to download, install, configure, and use the
MicroStrategy Mobile Suite.
Manuals for query, reporting, and analysis
•
MicroStrategy Installation and Configuration Guide
Information to install and configure MicroStrategy products on
Windows, UNIX, Linux, and HP platforms, as well as basic maintenance guidelines.
•
MicroStrategy Upgrade Guide
Instructions to upgrade existing MicroStrategy products.
•
MicroStrategy Project Design Guide
Information to create and modify MicroStrategy projects, and understand facts, attributes, hierarchies, transformations, advanced schemas, and project optimization.
•
MicroStrategy Basic Reporting Guide
Instructions to get started with MicroStrategy Desktop and
MicroStrategy Web, and how to analyze data in a report. Includes the basics for creating reports, metrics, filters, and prompts.
© 2012 MicroStrategy, Inc.
Resources
xxi
Book Overview and Additional Resources MicroStrategy Functions Reference
•
MicroStrategy Advanced Reporting Guide: Enhancing Your Business
Intelligence Application
Instructions for advanced topics in the MicroStrategy system, building on information in the Basic Reporting Guide. Topics include reports,
Freeform SQL reports, Query Builder reports, filters, metrics, Data
Mining Services, custom groups, consolidations, and prompts.
•
MicroStrategy Report Services Document Analysis Guide: Analyzing
Data with Report Services Documents
Instructions for a business analyst to execute and analyze a document in
MicroStrategy Desktop and MicroStrategy Web, building on basic concepts about projects and reports presented in the MicroStrategy
Basic Reporting Guide.
•
MicroStrategy Report Services Document Creation Guide: Creating
Boardroom Quality Documents
Instructions to design and create Report Services documents, building on information in the MicroStrategy Report Services Document Analysis
Guide. It is organized to help guide you through creating a new document, from creating the document itself, to adding objects to the new document, and formatting the document and its objects.
•
MicroStrategy Dashboards and Widgets Creation Guide: Creating
Interactive Dashboards for your Data
Instructions for designing and creating MicroStrategy Report Services dashboards, a type of document that is optimized for viewing online and for user interactivity. It builds on the basic concepts about documents presented in the MicroStrategy Report Services Document Creation
Guide.
•
MicroStrategy OLAP Services Guide
Information on MicroStrategy OLAP Services, which is an extension of
MicroStrategy Intelligence Server. OLAP Services features include
Intelligent Cubes, derived metrics, derived elements, dynamic aggregation, view filters, and dynamic sourcing.
•
MicroStrategy Office User Guide
Instructions for using MicroStrategy Office to work with MicroStrategy reports and documents in Microsoft® Excel, PowerPoint, Word, and
Outlook, to analyze, format, and distribute business data.
xxii
Resources © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Book Overview and Additional Resources
•
MicroStrategy Mobile Analysis Guide: Analyzing Data with
MicroStrategy Mobile
Information and instructions for using MicroStrategy Mobile to view and analyze data, and perform other business tasks with MicroStrategy reports and documents on a mobile device.
•
MicroStrategy Mobile Design and Administration Guide: A Platform for
Mobile Intelligence
Information and instructions to install and configure MicroStrategy
Mobile, as well as instructions for a designer working in MicroStrategy
Desktop or MicroStrategy Web to create effective reports and documents for use with MicroStrategy Mobile.
•
MicroStrategy System Administration Guide: Tuning, Monitoring, and
Troubleshooting your MicroStrategy Business Intelligence System
Concepts and high-level steps to implement, deploy, maintain, tune, and troubleshoot a MicroStrategy business intelligence system.
•
MicroStrategy Supplemental Reference for System Administration:
VLDB Properties, Internationalization, User Privileges, and other
Supplemental Information for Administrators
Information and instructions for MicroStrategy administrative tasks such as configuring VLDB properties and defining data and metadata internationalization, and reference material for other administrative tasks.
•
MicroStrategy Functions Reference
Function syntax and formula components; instructions to use functions in metrics, filters, attribute forms; examples of functions in business scenarios.
•
MicroStrategy MDX Cube Reporting Guide
Information to integrate MicroStrategy with MDX cube sources. You can integrate data from MDX cube sources into your MicroStrategy projects and applications.
Manuals for Analytics Modules
•
Analytics Modules Installation and Porting Guide
•
Customer Analysis Module Reference
•
Sales Force Analysis Module Reference
© 2012 MicroStrategy, Inc.
Resources
xxiii
Book Overview and Additional Resources MicroStrategy Functions Reference
•
Financial Reporting Analysis Module Reference
•
Sales and Distribution Analysis Module Reference
•
Human Resources Analysis Module Reference
Manuals for Narrowcast Services products
•
MicroStrategy Narrowcast Server Getting Started Guide
Instructions to work with the tutorial to learn Narrowcast Server interfaces and features.
•
MicroStrategy Narrowcast Server Installation and Configuration Guide
Information to install and configure Narrowcast Server.
•
MicroStrategy Narrowcast Server Application Designer Guide
Fundamentals of designing Narrowcast Server applications.
•
MicroStrategy Narrowcast Server System Administrator Guide
Concepts and high-level steps to implement, maintain, tune, and troubleshoot Narrowcast Server.
•
MicroStrategy Narrowcast Server Upgrade Guide
Instructions to upgrade an existing Narrowcast Server.
Software Development Kits
•
MicroStrategy Developer Library (MSDL)
Information to understand the MicroStrategy SDK, including details about architecture, object models, customization scenarios, code samples, and so on.
•
MicroStrategy Web SDK
The Web SDK is available in the MicroStrategy Developer Library, which is sold as part of the MicroStrategy SDK.
•
Narrowcast Server SDK Guide
Instructions to customize Narrowcast Server functionality, integrate
Narrowcast Server with other systems, and embed Narrowcast Server functionality within other applications. Documents the Narrowcast
xxiv
Resources © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Book Overview and Additional Resources
Server Delivery Engine and Subscription Portal APIs, and the Narrowcast
Server SPI.
Documentation for MicroStrategy Portlets
•
Enterprise Portal Integration Help
Information to help you implement and deploy MicroStrategy BI within your enterprise portal, including instructions for installing and configuring out-of-the-box MicroStrategy Portlets for several major enterprise portal servers.
This resource can be accessed using the MicroStrategy Product Manuals page, as described in
Accessing manuals and other documentation sources, page xxvi
.
Documentation for MicroStrategy GIS Connectors
•
GIS Integration Help
Information to help you integrate MicroStrategy with Geospatial
Information Systems (GIS), including specific examples for integrating with various third-party mapping services.
This resource can be accessed using the MicroStrategy Product Manuals page, as described in
Accessing manuals and other documentation sources, page xxvi
.
Help
Each MicroStrategy product includes an integrated help system to complement the various interfaces of the product as well as the tasks that can be accomplished using the product.
Some of the MicroStrategy help systems require a web browser to be viewed.
For supported web browsers, see the MicroStrategy Readme.
MicroStrategy provides several ways to access help:
•
Help button: Use the Help button or ? (question mark) icon on most software windows to see help for that window.
© 2012 MicroStrategy, Inc.
Resources
xxv
Book Overview and Additional Resources MicroStrategy Functions Reference
•
Help menu: From the Help menu or link at the top of any screen, select
MicroStrategy Help to see the table of contents, the Search field, and the index for the help system.
•
F1 key: Press F1 to see context-sensitive help that describes each option in the software window you are currently viewing.
For MicroStrategy Web, MicroStrategy Web Administrator, and
MicroStrategy Mobile Server, pressing the F1 key opens the context-sensitive help for the web browser you are using to access these MicroStrategy interfaces. Use the Help menu or ? (question mark) icon to access help for these MicroStrategy interfaces.
Accessing manuals and other documentation sources
The manuals are available from your MicroStrategy disk or the machine where MicroStrategy was installed.
Adobe Acrobat Reader is required to view these manuals. If you do not have Acrobat Reader installed on your computer, you can download it from
http://get.adobe.com/reader/
.
The best place for all users to begin is with the MicroStrategy Basic
Reporting Guide.
To access the installed manuals and other documentation sources, see the following procedures:
•
To access installed manuals and other documentation sources on
Windows, page xxvi
•
To access installed manuals and other documentation sources on UNIX and Linux, page xxvii
To access installed manuals and other documentation sources on Windows
1
From the Windows Start menu, choose Programs (or All Programs),
MicroStrategy
, then Product Manuals. A page opens in your browser showing a list of available manuals in PDF format and other documentation sources.
2
Click the link for the desired manual or other documentation source.
xxvi
Resources © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Book Overview and Additional Resources
3
If you click the link for the Narrowcast Services SDK Guide, a File
Download dialog box opens. This documentation resource must be downloaded. Select Open this file from its current location, and click
OK
.
If bookmarks are not visible on the left side of an Acrobat (PDF) manual, from the View menu click Bookmarks and Page. This step varies slightly depending on your version of Adobe Acrobat Reader.
To access installed manuals and other documentation sources on UNIX and
Linux
1
Within your UNIX or Linux machine, navigate to the directory where you installed MicroStrategy. The default location is /opt/MicroStrategy, or $HOME/MicroStrategy/install if you do not have write access to
/opt/MicroStrategy.
2
From the MicroStrategy installation directory, open the
Documentation folder.
3
Open the Product_Manuals.htm file in a web browser. A page opens in your browser showing a list of available manuals in PDF format and other documentation sources.
4
Click the link for the desired manual or other documentation source.
5
If you click the link for the Narrowcast Services SDK Guide, a File
Download dialog box opens. This documentation resource must be downloaded. Select Open this file from its current location, and click
OK
.
If bookmarks are not visible on the left side of an Acrobat (PDF) manual, from the View menu click Bookmarks and Page. This step varies slightly depending on your version of Adobe Acrobat Reader.
Resources
xxvii
© 2012 MicroStrategy, Inc.
Book Overview and Additional Resources MicroStrategy Functions Reference
Documentation standards
MicroStrategy online help and PDF manuals (available both online and in printed format) use standards to help you identify certain types of content.
The following table lists these standards.
These standards may differ depending on the language of this manual; some languages have rules that supersede the table below.
Type Indicates bold
• Button names, check boxes, options, lists, and menus that are the focus of actions or part of a list of such GUI elements and their definitions
Example: Click Select Warehouse.
italic
Courier font
• New terms defined within the text and in the glossary
• Names of other product manuals and documentation resources
• When part of a command syntax, indicates variable information to be replaced by the user
Example: The
aggregation level
is the level of calculation for the metric.
Example: Type copy c:\filename d:\foldername\filename
• Calculations
• Code samples
• Registry keys
• Path and file names
• URLs
• Messages displayed in the screen
• Text to be entered by the user
Example: Sum(revenue)/number of months.
Example: Type cmdmgr -f scriptfile.scp and press Enter.
+ A keyboard command that calls for the use of more than one key (for example,
SHIFT+F1).
A note icon indicates helpful information for specific situations.
A warning icon alerts you to important information such as potential security risks; these should be read before continuing.
Education
MicroStrategy Education Services provides a comprehensive curriculum and highly skilled education consultants. Many customers and partners from over 800 different organizations have benefited from MicroStrategy instruction.
xxviii
Resources © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Book Overview and Additional Resources
Courses that can help you prepare for using this manual or that address some of the information in this manual include:
•
MicroStrategy Desktop: Reporting Essentials
•
MicroStrategy Web: Report Analysis
•
MicroStrategy Web: Report Design
For a detailed description of education offerings and course curriculums, visit
http://www.microstrategy.com/Education
.
Consulting
MicroStrategy Consulting Services provides proven methods for delivering leading-edge technology solutions. Offerings include complex security architecture designs, performance and tuning, project and testing strategies and recommendations, strategic planning, and more. For a detailed description of consulting offerings, visit
http://www.microstrategy.com/
Services
.
International support
MicroStrategy supports several locales. Support for a locale typically includes native database and operating system support, support for date formats, numeric formats, currency symbols, and availability of translated interfaces and certain documentation.
MicroStrategy is certified in homogeneous configurations (where all the components lie in the same locale) in the following languages—English (US),
French, German, Italian, Japanese, Korean, Portuguese (Brazilian), Spanish,
Chinese (Simplified), Chinese (Traditional), Danish, and Swedish. A translated user interface is available in each of the above languages. For information on specific languages supported by individual MicroStrategy system components, see the MicroStrategy readme.
MicroStrategy also provides limited support for heterogeneous configurations (where some of the components may lie in different locales).
Please contact MicroStrategy Technical Support for more details.
© 2012 MicroStrategy, Inc.
Resources
xxix
Book Overview and Additional Resources MicroStrategy Functions Reference
Technical Support
If you have questions about a specific MicroStrategy product, you should:
1
Consult the product guides, Help, and readme files. Locations to access each are described above.
2
Consult the MicroStrategy Knowledge Base online at
https:// resource.microstrategy.com/support
.
A technical administrator in your organization may be able to help you resolve your issues immediately.
3
If the resources listed in the steps above do not provide a solution, contact MicroStrategy Technical Support directly. To ensure the most productive relationship with MicroStrategy Technical Support, review the
Policies and Procedures document in your language, posted at
http:// www.microstrategy.com/Support/Policies
. Refer to the terms of your purchase agreement to determine the type of support available to you.
MicroStrategy Technical Support can be contacted by your company’s
Support Liaison. A Support Liaison is a person whom your company has designated as a point-of-contact with MicroStrategy’s support personnel. All customer inquiries and case communications must come through these named individuals. Your company may designate two employees to serve as their Support Liaisons, and can request to change their Support Liaisons two times per year with prior written notice to MicroStrategy Technical Support.
It is recommended that you designate Support Liaisons who have
MicroStrategy Administrator privileges. This can eliminate security conflicts and improve case resolution time. When troubleshooting and researching issues, MicroStrategy Technical Support personnel may make recommendations that require administrative privileges within
MicroStrategy, or that assume that the designated Support Liaison has a security level that permits them to fully manipulate the MicroStrategy projects and has access to potentially sensitive project data such as security filter definitions.
xxx
Resources © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Book Overview and Additional Resources
Ensure issues are resolved quickly
Before logging a case with MicroStrategy Technical Support, the Support
Liaison may follow the steps below to ensure that issues are resolved quickly:
1
Verify that the issue is with MicroStrategy software and not a third party software.
2
Verify that the system is using a currently supported version of
MicroStrategy software by checking the Product Support Expiration
Schedule at
http://www.microstrategy.com/Support/Expiration.asp
.
3
Attempt to reproduce the issue and determine whether it occurs consistently.
4
Minimize the complexity of the system or project object definition to isolate the cause.
5
Determine whether the issue occurs on a local machine or on multiple machines in the customer environment.
6
Discuss the issue with other users by posting a question about the issue on the MicroStrategy Customer Forum at
https:// resource.microstrategy.com/forum/
.
The following table shows where, when, and how to contact MicroStrategy
Technical Support. If your Support Liaison is unable to reach MicroStrategy
Technical Support by phone during the hours of operation, they can leave a voicemail message, send email or fax, or log a case using the Online Support
© 2012 MicroStrategy, Inc.
Resources
xxxi
Book Overview and Additional Resources MicroStrategy Functions Reference
North America
EMEA:
Europe
The Middle East
Africa
Asia Pacific
Latin America
Interface. The individual Technical Support Centers are closed on certain public holidays.
Email: [email protected]
Web:
https://resource.microstrategy.com/support
Fax: (703) 842–8709
Phone: (703) 848–8700
Hours: 9:00 A.M.–7:00 P.M. Eastern Time, Monday–Friday except holidays
Email: [email protected]
Web:
https://resource.microstrategy.com/support
Fax: +44 (0) 208 711 2525
The European Technical Support Centre is closed on national public holidays in each country.
Phone:
• Belgium: + 32 2792 0436
• France: +33 17 099 4737
• Germany: +49 22 16501 0609
• Ireland: +353 1436 0916
• Italy: +39 023626 9668
• Poland: +48 22 459 52 52
• Scandinavia & Finland: +46 8505 20421
• Spain: +34 91788 9852
• The Netherlands: +31 20 794 8425
• UK: +44 (0) 208 080 2182
• International distributors: +44 (0) 208 080 2183
Hours:
• United Kingdom: 9:00 A.M.–6:00 P.M. GMT, Monday-Friday except holidays
• EMEA (except UK): 9:00 A.M.–6:00 P.M. CET, Monday-Friday except holidays
Email: [email protected]
Web:
https://resource.microstrategy.com/support
Phone:
• Australia: +61 2 9333 6499
• Korea: +82 2 560 6565 Fax: +82 2 560 6555
• Japan: +81 3 3511 6720 Fax: +81 3 3511 6740
• Singapore: +65 6303 8969 Fax: +65 6303 8999
• Asia Pacific (except Australia, Japan, Korea, and Singapore): +86 571 8526 8067 Fax: +86
571 8848 0977
Hours:
• Japan and Korea: 9:00 A.M.–6:00 P.M. JST (Tokyo), Monday-Friday except holidays
• Asia Pacific (except Japan and Korea): 7 A.M.-6 P.M. (Singapore) Monday-Friday except holidays
Email: [email protected]
Web:
https://resource.microstrategy.com/support
Phone:
• LATAM (except Brazil and Argentina): +54 11 5222 9360 Fax: +54 11 5222 9355
• Argentina: 0 800 444 MSTR Fax: +54 11 5222 9355
• Brazil: +55 11 3054 1010 Fax: +55 11 3044 4088
Hours:
• Latin America (except Brazil): 9:00 A.M.–7:00 P.M. (Buenos Aires), Monday-Friday except holidays
• Brazil: 9 A.M. - 6 P.M. (São Paulo), Monday–Friday except holidays
xxxii
Resources © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Book Overview and Additional Resources
Support Liaisons should contact the Technical Support Center from which they obtained their MicroStrategy software licenses or the Technical Support
Center to which they have been designated.
Required information when calling
When contacting MicroStrategy Technical Support, please provide the following information:
•
Personal information:
Name (first and last)
Company and customer site (if different from company)
Contact information (phone and fax numbers, e-mail addresses)
•
Case details:
Configuration information, including MicroStrategy software product(s) and versions
Full description of the case including symptoms, error messages(s), and steps taken to troubleshoot the case thus far
•
Business/system impact
If this is the Support Liaison’s first call, they should also be prepared to provide the following:
•
Street address
•
Phone number
•
Fax number
•
Email address
To help the Technical Support representative resolve the problem promptly and effectively, be prepared to provide the following additional information:
•
Case number: Please keep a record of the number assigned to each case logged with MicroStrategy Technical Support, and be ready to provide it when inquiring about an existing case
•
Software version and product registration numbers of the MicroStrategy software products you are using
© 2012 MicroStrategy, Inc.
Resources
xxxiii
Book Overview and Additional Resources MicroStrategy Functions Reference
•
Case description:
What causes the condition to occur?
Does the condition occur sporadically or each time a certain action is performed?
Does the condition occur on all machines or just on one?
When did the condition first occur?
What events took place immediately prior to the first occurrence of the condition (for example, a major database load, a database move, or a software upgrade)?
If there was an error message, what was its exact wording?
What steps have you taken to isolate and resolve the issue? What were the results?
•
System configuration (the information needed depends on the nature of the problem; not all items listed below may be necessary):
Computer hardware specifications (processor speed, RAM, disk space, and so on)
Network protocol used
ODBC driver manufacturer and version
Database gateway software version
(For MicroStrategy Web-related problems) browser manufacturer and version
(For MicroStrategy Web-related problems) Web server manufacturer and version
If the issue requires additional investigation or testing, the Support Liaison and the MicroStrategy Technical Support representative should agree on certain action items to be performed. The Support Liaison should perform any agreed-upon actions before contacting MicroStrategy Technical Support again regarding the issue. If the Technical Support representative is responsible for an action item, the Support Liaison may call MicroStrategy
Technical Support at any time to inquire about the status of the issue.
xxxiv
Resources © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Book Overview and Additional Resources
Feedback
Please send any comments or suggestions about user documentation for
MicroStrategy products to: [email protected]
Send suggestions for product enhancements to: [email protected]
When you provide feedback to us, please include the name and version of the products you are currently using. Your feedback is important to us as we prepare for future releases.
© 2012 MicroStrategy, Inc.
Feedback
xxxv
Book Overview and Additional Resources MicroStrategy Functions Reference
xxxvi
Feedback © 2012 MicroStrategy, Inc.
1
1.
U
NDERSTANDING
F
UNCTIONS
IN
M
ICRO
S
TRATEGY
Introduction
This chapter provides the following information:
•
The basics of MicroStrategy objects, object definitions, and functions, page 2
•
Function syntax and formula components, page 4
•
Using functions in expressions, page 27
•
Adding functions to expressions with the Insert Function Wizard, page 45
•
How MicroStrategy processes functions, page 48
•
Additional examples of functions in expressions, page 68
© 2012 MicroStrategy, Inc.
1
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
The basics of MicroStrategy objects, object definitions, and functions
To understand functions and their role in MicroStrategy, it is important to grasp the basic concepts underlying objects and expressions.
An object is a basic building block in MicroStrategy. There are three types of objects: schema objects, application objects, and configuration objects.
Schema objects
include facts, hierarchies, and custom groups;
application objects
include reports, documents, and metrics; and
configuration objects
include project sources, database instances, and users. (This list of objects is not exhaustive.)
Microstrategy objects are created, maintained and deleted by you. Your
Architect, for instance, will create
attributes
by mapping conceptual data from your data warehouse to names like Month, Customer Name, or Product
Category that will appear on your reports. Your Designer will create
metrics
that access and manipulate numeric data from your data warehouse.
Many objects require you to specify an expression when creating or modifying them. An expression is any combination of characters that can be used as a result. Examples include the following:
•
Month + 5
•
Sum(Revenue)
•
New York AND Los Angeles
In the first example, each Month element in your data warehouse is assigned a numeric ID between 1 and 12, where January is 1, February is 2, and so on.
You want to generate a report with a five-month forecast. One approach would begin with creating a new attribute called 5 Months Ahead, using the expression Month + 5 in its attribute definition.
Expressions can be used in many places. Metrics in particular often require complicated expressions. In the second example above, the expression
Sum(Revenue) is used to define a relatively simple metric. “Sum” tells
Microstrategy to read individual Revenue entries from the data warehouse and add them together to produce one single number that will be displayed as Revenue on your report. This metric is a Microstrategy object that you can create.
2
The basics of MicroStrategy objects, object definitions, and functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
The last example above shows a logical expression, which might be used in a filter. A filter comprised of the expression New York AND Los Angeles would let a user answer questions such as “Which business travelers flew out of New York and out of Los Angeles in 2006?”
Expressions often form the basis of objects, which are the basic building blocks of all MicroStrategy content and functionality. Objects that rely on these expressions are often edited by changing the object expressions.
In this book, the terms “object expression” and “object definition” are interchangeable unless otherwise noted.
To create an expression that accomplishes your goal, you will almost always utilize a Microstrategy function. Functions in MicroStrategy are powerful tools used to define MicroStrategy objects (when they are integrated into object definitions) and initiate complex user-selected calculations. The example Sum(Profit) in a metric definition uses the Sum function to add various Profit entries in a data warehouse to arrive at one final number to display on a report.
Wherever you use an expression, you can use a function. From creating basic objects to building complex reports and analyzing data, you can create custom expressions using a large library of functions that come with and are supported by MicroStrategy. Although functions are most commonly used in metric expressions, they are also used to define attribute forms, consolidation elements, custom groups, filters, facts, subtotals, and transformations, all of which are MicroStrategy objects.
Functions commonly used to create specific objects
The following table lists the function types described above, several functions belonging to each type, and the MicroStrategy objects that can be created using those functions.
Function type Function Examples
Single-value • Arithmetic operators
(
–, +, /, *)
• Abs
• Round
• Ln
• Cos
Group-value • Avg
• Count
• Sum
MicroStrategy Objects That Can Use These Functions
• Attribute form
• Consolidation
• Custom group
• Fact
• Metric
• Subtotal
• Transformation
• Metric
• Subtotal
The basics of MicroStrategy objects, object definitions, and functions
3
© 2012 MicroStrategy, Inc.
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
Function type Function Examples
OLAP
Logical
Comparison
Apply
• Rank
• MovingMin
• NTile
• And
• Or
• Between
• ApplyComparison
• ApplySimple
• ApplyAgg
• ApplyOLAP
• ApplyLogic
• ApplyComparison
MicroStrategy Objects That Can Use These Functions
Metric
Filter
Filter
• Attribute form
• Consolidation
• Custom group
• Fact
• Metric
• Transformation
• Filter
Function syntax and formula components
You can use functions in any situations where you build an expression.
Although an expression can have unique characteristics, there is a basic syntax for applying functions in expressions. The use of each function is described in detail in the rest of this book. This section covers the basics of functions and their key components.
Each function is designated by a function name. Functions operate on an argument that can be a fact, attribute, metric, or constant, and the function’s behavior is often further specified using one or more parameters. Function parameters are used to fine-tune the behavior of functions. Arguments provide the inputs to functions
In this guide, MicroStrategy functions are grouped into function types. This section provides information on function types, as well as their parameters and arguments.
4
Function syntax and formula components © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
This guide does not include information on Data Mining functions. This information can be found in the Data Mining Services chapter of the
MicroStrategy Advanced Reporting Guide.
Function types
MicroStrategy functions are classified into the following types:
• Single-value functions
(also known as Non-grouping or Scalar functions): These functions operate on each individual component of an input variable or argument, resulting in an output element for each component. Examples of this category are simple mathematical operators
(+, -, *, /), Abs, Accrint, Ddb, Cos, Ln, Round, Truncate, ApplySimple, and so on. For details, see
Single-value functions, page 6
.
• Group-value functions
(also known as Grouping or Aggregate functions): These functions take one or more lists of values as input and generate a single output value for each list. Examples of this category are
Avg, AvgDev, Correlation, Count, HomoscedasticTTest, Intercept, Slope,
StDev, Sum, ApplyAgg, and so on. For details, see
.
• OLAP functions
(also known as Relative functions): These functions take multiple elements from a list and return a new list of elements. Each element is related to and dependent on one or more other elements in the list, and the relative positions of elements within the list determines how computation is performed. Examples include Rank, RunningSum,
MovingAvg, NTile, ApplyOLAP, and so on. For details, see
• Comparison functions
: These functions compare single values or lists of values, or compare a list to a threshold value. Examples of this category are Between, Like, Greater than(>), Less than (<), ApplyComparison, and so on. For details, see
.
• Logical functions
: These functions provide basic comparisons and return TRUE or FALSE values based on the evaluation of the formula.
This type of function includes And, Or, and Not. For details, see
• Apply functions
: These functions provide access to functions and syntactic constructs that are not standard in MicroStrategy but are offered by various relational database management system (RDBMS) platforms. Each of the functions in this category substitutes for one of the function types mentioned above and can be used wherever that type is used. For example, ApplySimple can be used wherever a single-value
© 2012 MicroStrategy, Inc.
Function syntax and formula components
5
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference function is used. For details, see
Apply (Pass-through) functions, page 11
Single-value functions
A single-value function operates on each individual component of one or more arguments, resulting in an output component for each set of input components. Subtraction, addition, division, and multiplication operators
(–, +, /, *) are common examples of single-value functions. Other examples include Abs, Cos, Ln, Round, Sin, Trunc, ApplySimple, and so on.
Single-value functions can be used to create facts, metrics, attribute forms, consolidation elements, and transformations.
For example, using a single-value function that operates on four arguments, where each argument is composed of a five-component list, returns five components. In other words, the number of output components is equal to the number of input components in each argument. A simple example using numbers follows:
Using the single-value “+” (addition) function, A+B=C
Where
•
A=1 (an argument containing one component whose value is 1)
•
B=2 (an argument containing a single component whose value is 2)
•
C=3 (the returned value, containing a single output component, whose value is 3)
In the example above, A, B, and C each contain one component. More generally, given variables D and E used as arguments in the addition function, where D and E each contain a five-component list, D+E results in a five-component list. Single-value functions need not take a single value as an argument or even a single argument. Rather, the basic requirement for a function to be categorized as single-value is that the number of output components equals the number of input components of the arguments.
The following two examples illustrate the use of single-value functions in the creation of a transformed fact and a compound metric. Transforming a fact and creating a compound metric are similar in that both use a single-value function to turn one or more lists of values into another list of values. They
6
Function syntax and formula components © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1 differ in that, for a transformation, the single-value function must be applied before a group-value function, while in a compound metric the single-value function is applied after the group-value function.
Example 1: Transformed fact
Avg(Abs([Account Transactions]))
Suppose Account Transactions is a list of the following values: -300.5, -7.7,
900, -80, and 2.2. The single-value function, Absolute, is applied to the list.
The result set is the absolute value of each element in the list: 300.5, 7.7,
900, 80, 2.2. It is important to note that the single-value function returns five elements of output for five elements of input. Once the single-value function has been applied, the group-value function, Avg, is applied to produce an average of those values, 258.08. For more information on the
Abs and Avg functions, see
Abs (absolute value), page 324
Example 2: Compound metric
Avg(Revenue){Quarter} - Avg(Cost){Quarter}
In this example, the group-value function Avg is applied to both the Revenue and Cost facts in your data warehouse. First, Microstrategy uses the list of values for the two input variables Revenue and Cost to generate, using the
Avg function twice, two new variables each containing a single value. The two resulting variables are stored as intermediate results. Next, the single-value function “-” (subtraction) is applied by Microstrategy to subtract one intermediate result from the other, resulting in a single value for the metric.
For more information on the Abs and Avg functions, see
Abs (absolute value), page 324
In both of the previous examples, both single-value and group-value functions were used. The next section addresses group-value functions in more detail.
© 2012 MicroStrategy, Inc.
Function syntax and formula components
7
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
Group-value functions
A group-value function takes one or more lists of values as input and returns a single output value for each list. The existence of a GROUP BY clause in a
SQL statement indicates that you are using a group-value function.
The most common group-value functions include Avg, Count, Max, Median,
Min, Stdev, Sum, Var, ApplyAgg, and so on. First, Last, IRR, and NPV functions also belong to this category, but they have an additional sort by
feature (for more information, see
Sort by
specifies the order that the values returned by an expression will appear on a
report. (For more information on the Sort By parameter, see
.)
Group-value functions can be used to create simple metrics, nested metrics, and compound metrics, as well as in the calculation of subtotals. The following examples illustrate their use.
Example 1: Average
Avg([Employee Age])
In this example, the group-value function Avg operates on the argument
Employee Age, which is a list of the following elements: 27, 35, 32, 47, 43, 40,
30. The function reduces the seven elements of the input value to a single output value of 36. For more information on the Avg function, see
Example 2: Median
Median([Employee Age])
The only difference between Example 2 and Example 1 above is the fact that the group-value function, Median, is used, instead of Avg. Again, the function reduces the seven elements of the input value to a single output value of 35. For more information, see
8
Function syntax and formula components © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
OLAP (Relative) functions
Online Analytical Processing (OLAP) functions are also referred to as
Relative functions because each element in a list of values is related to and dependent on one or more other elements in the list, and the positions of the elements within the list determine how computation is performed.
An OLAP function takes multiple elements from a list and returns a new list of elements. Unlike group-value functions, though, the number of elements in the input list and the number of elements in the output list remains the same. Unlike single-value functions, the computation depends upon the conditions set by the BreakBy parameter that defines when the calculation restarts and the SortBy parameter that defines how the list of values is sorted
(see
).
OLAP functions include Rank, all the functions with Moving as the prefix of the name (for example, MovingDifference, MovingMin, MovingStdev, and so on), all the functions with Running as the prefix (for example, RunningAvg,
RunningCount, RunningSum, and so on), and all the NTile functions (such as NTile, NTileSize, NTileValue, and NTileValueSize). ApplyOLAP also belongs to the OLAP category.
OLAP functions are only used in the creation of metrics. The following is an example.
Example: RunningSum
RunningSum <BreakBy={[Customer Region]}, SortBy=
([Customer State]) >(Revenue)
BreakBy
refers to the attribute or hierarchy where calculations for an OLAP function restart. To break by an attribute or hierarchy means to restart calculations that use OLAP, or Relative, functions when the analytical engine reaches the next instance of the specified attribute or hierarchy. Examples of
OLAP functions include RunningStdevP, Rank, NTile, and various expressions that calculate percent values. To break by an attribute or hierarchy in an expression, you set the BreakBy parameter.
The RunningSum metric computes the sum of the revenue for each
Customer Region by adding the revenue for each Customer State to the revenue of the Customer States in the rows above it and displaying the incremented total. The BreakBy Customer Region condition causes calculations to begins again, however, when the next Customer Region is encountered. (Notice in the figure below that the Total Revenue and the
Running Sum for Arizona are equal because the calculation for RunningSum
© 2012 MicroStrategy, Inc.
Function syntax and formula components
9
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference has restarted, since Arizona is categorized in Southwest, a different
Customer Region than Wyoming, the previous Customer State on the report.) Because of the SortBy Customer State condition, the Customer
States are listed in ascending (alphabetical) order, as shown in the report excerpt below.
Comparison functions
Comparison functions allow you to compare values. Using these functions, you can compare single values or lists of values, or compare a list to a threshold value.
Comparison operators include < (less than), > (greater than), = (is equal to),
Between, Contains, Ends with, ApplyComparision, and so on. They are only used to create filters, which limit report data to a subset based on your need.
Example: > (Greater than)
Revenue > “500000”
In this example, the filter limits the states in your yearly income report to those with accrued revenue greater than $500,000.
10
Function syntax and formula components © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
Logical functions
Logical functions provide basic comparisons and return TRUE or FALSE values based on the evaluation of the formula. For numeric values, 0 is treated as FALSE, and 1 is treated as TRUE. These functions provide a means to combine data evaluations and comparison operators into complex expressions. These expressions, in turn, can answer questions such as
“Which of our regions produced revenue that exceeded a ‘success’ threshold?”
Logical operators include And, Or, Not, and ApplyLogic, all of which can only be used to build filters where criteria are provided for the inclusion and exclusion of data from a report display or metric calculation.
Example: And
((Revenue - Cost) > 50000) And [Sell-through Percentage]
> 25
Built for the attribute State, this filter limits report data to those states where
Profit (defined as Revenue - Cost) is greater than $50,000 and the
Sell-through Percentage is greater than 25%.
Apply (Pass-through) functions
The terms Apply functions and Pass-through functions are interchangeable.
They both denote functions in Microstrategy that provide access to functions or syntactic constructs that are not standard in Microstrategy but are provided by various Relational Database Management System (RDBMS) platforms. The name “Pass-through” derives from the fact that Microstrategy passes information to a database which then uses its own functions. (Using the native functionality of your RDBMS via Pass-through functions requires that you know the syntax of your particular RDBMS. That syntax is beyond the scope of this book and will vary from RDBMS to RDBMS.) RDBMS functions, while necessary, must be used with care, since they always bypass
Microstrategy’s parsers and validators.
There are five predefined Apply functions that can be used to replace regular or predefined functions of the same type. The functions are as follows:
•
ApplySimple: These functions are used where simple (e.g., arithmetic) operators can be used.
© 2012 MicroStrategy, Inc.
Function syntax and formula components
11
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
•
ApplyAgg: These functions are used where aggregate functions (e.g.,
Sum) can be used.
•
ApplyRelative: These functions are used where Online Analytical
Processing (OLAP) functions (e.g., Rank) can be used.
•
ApplyComparison: These functions are used where comparison operators
(e.g., >, =, Like and In) can be used.
•
ApplyLogic: These functions are used where logical operators (e.g., AND,
OR, and NOT) can be used.
With Apply functions, project designers can customize expressions in the
Attribute, Filter and Metric editors to utilize RDBMS functions that are not provided by Microstrategy.
MicroStrategy strongly advises against using Apply functions when standard Microstrategy functions can be used to achieve the same goal, because using RDBMS functions effectively bypasses the validations and other benefits of MicroStrategy products. Using Apply functions is recommended only when corresponding functionality does not exist in the MicroStrategy product. When you need to use an
Apply function, Microstrategy encourages you to submit an enhancement request for inclusion of the desired feature in a future product release.
Example: ApplyComparison used to check a prompted date
In this example, a table in your data warehouse contains the columns Item,
Effec Date, and Term Date (as well as Revenue), as shown below:
Item Effec Date
Blouse
Jeans
06/01/2007
05/30/2007
Gloves 10/01/2007
Leather Shoes 06/15/2007
Winter Hat
Winter Boots
11/01/2007
12/01/2007
Term Date
07/30/2007
06/17/2007
10/25/2007
06/22/2007
11/08/2007
12/15/2007
Revenue
1000
500
150
750
900
2200
Each row in the table corresponds to an item that was on sale during the time between Effec Date and Term Date. Your objective is to generate a report that lists all items (and an associated metric that you choose) that were on
12
Function syntax and formula components © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1 sale on a particular date your user chooses at run time. To generate this report, first create a value prompt named Test Date that allows the user to input a date. Next, using that prompt, create a report filter using the Custom expression box located in the Advanced Qualification pane of the Filter
Editor, as shown below.
Even though the filter is validated when you click Validate, MicroStrategy returns an error when the report is executed. The error results from the fact that you are supplying the SQL engine with two attributes and a value prompt, while MicroStrategy is expecting to compare an attribute to the attributes Effec Date and Term Date. In effect, you have a “type mismatch” problem.
In this case, you can use an Apply function. Instead of having MicroStrategy test the date value prompt, you instruct your database to perform the test. It is important to remember that you have chosen to use an Apply function only because MicroStrategy does not have a built-in function to accomplish your task. If an appropriate MicroStrategy function existed, you would have used it instead of an RDBMS function, because the latter does not offer the validating features that MicroStrategy does. (To use Apply functions, you must know the syntax of the corresponding function or operation in the
RDBMS you are using.)
To test the date prompt, use a custom expression to pass three values to the database for comparison: the value prompt Test Date, the attribute Effec
Date, and the attribute Term Date. All three of these values are passed to the database using placeholders in the form of #n, where n is a positive integer that increases by 1 for each successive item being passed, starting with 0. The first value passed is referred to as #0, the second is #1, the third #2, and so
© 2012 MicroStrategy, Inc.
Function syntax and formula components
13
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference on. The Custom expression in the Advanced Qualification pane of the Filter
Editor depicted below shows the syntax needed for this example:
Notice that the syntax is nested. The outer portion of the expression contains the Microstrategy function ApplyComparison, as well as the Microstrategy prompt Test Date and the attributes Effec Date and Term Date.
The inner portion of the syntax, which is contained within double quotes, is the database operation #0 between #1 and #2. Code that is passed to the database using an Apply function is always enclosed in quotes, and the arguments that are passed with that code are written as placeholders in the form of #n, with the specific forms of the passed attributes specified by the characters after the “@” sign. In this example, [Effec Date]@ID specifies that Microstrategy pass the ID form of the Effec Attribute instead of the
DESC or any other form that may exist in the database. At run time, #0, #1, and #2 are replaced by Test Date, Effec Date, and Term Date, respectively, so that the database effectively receives the following syntax:
Test Date between Effec Date and TermDate
If the user chooses 06/16/07 as the value of Test Date at run time, the
RDBMS reads the table row by row to see if the date falls between Effec Date and Term Date. Whenever 06/16/07 falls between Effec Date and Term Date on a particular row, the item on that row is returned in the result set. In this example, Blouse, Jeans, and Leather Shoes are returned. (You can verify this result by looking at the data warehouse table shown in the beginning of this section.) If your report is set up with Item as a row attribute, those three items appear on your report, indicating that they (and only they) were on sale on 06/16/07.
14
Function syntax and formula components © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
For additional information about Apply functions, see
Apply (Pass-Through) functions, page 138
. The syntax of each Apply function as well as examples
appear in the sections that immediately follow.
Example: Test whether Hire Date is in the current year
Your HR department requires a list of employees that have been hired during the current calendar year. The following custom expression uses the
ApplySimple function to test whether the year of Hire Date is the same as the current year:
ApplySimple ( "datepart(yy, #0)", [Hire Date]@ID) =
ApplySimple ( "datepart(yy, getdate())", [Hire
Date]@ID)
Each piece of the custom expression is explained below. More detailed information on Apply functions in general can be found in
(Pass-through) functions, page 11
. More information on ApplySimple functions, specifically, is found in
•
The datepart function extracts a specified part of a given date. The first datepart function extracts the year (as directed by yy) from the ID attribute form of the Hire Date attribute. The ID attribute form—as opposed to the DESC or any other attribute form—is specified by @ID.
•
The placeholder, #0, stands for the argument [Hire Date]@ID that is passed to your RDBMS. (Apply functions use your database’s computational capabilities instead of those of MicroStrategy.)
•
The second datepart function extracts the year (as instructed by yy) from the current, or system, date. The system date is obtained via the
RDBMS function getdate().
•
Your RDBMS extracts the year from both the Hire Date and the system date, with MicroStrategy passing information to it. The container that hands the necessary function to your RDBMS is an Apply function,
ApplySimple. In other words, ApplySimple acts as an interface between you and the database, and when the RDBMS returns both year values, they are compared with the = operator. If the year of a particular Hire
Date element is the same as the year of the system date, the custom expression statement evaluates as true and that Hire Date attribute element is returned in the result set of your report. If the year of a particular Hire Date element is different than the year of the system date,
© 2012 MicroStrategy, Inc.
Function syntax and formula components
15
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference the custom expression statement evaluates as false, and that Hire Date attribute element is filtered out of the report.
The attribute Hire Date is enclosed in brackets. Any time you type an attribute whose name contains one or more spaces, the attribute must be enclosed in brackets. (The use of brackets around compound object names is standard for many objects in MicroStrategy and is not restricted to custom expressions and Apply functions.)
The above example used an Apply function, ApplySimple. The next example uses ApplyComparison.
Example: Customer City = Call Center using ApplyComparison
You need a list of customers who live in the same city as one of your call centers. While it is possible to generate this report with a custom expression that does not use an Apply function, this example uses an ApplyComparison function to demonstrate Apply functionality within the custom expression.
(For steps to create this report without the use of an Apply function, see the
Attribute-to-attribute qualifications section of the Advanced Filters chapter of the Advanced Reporting Guide.)
The custom expression used here evaluates whether one attribute is exactly the same as another:
ApplyComparison (“#0 like #1”,
[Customer City]@DESC, [Call Center]@DESC)
Each piece of the custom expression is explained below:
•
The ApplyComparison function is used with RDBMS comparison operators, such as the like operator used in this example.
•
#0 like #1 is the actual comparison, comparing the first argument, #0, with the second argument, #1. Remember that this comparison is done by your RDBMS—not by MicroStrategy.
•
[Customer City]@DESC sets the first argument passed to your
RDBMS as the description form of the Customer City attribute, while
[Call Center]@DESC sets the second argument passed to your
RDBMS as the description form of the Call Center attribute.
The attributes Customer City and Call Center are enclosed in brackets. Any time you type an attribute whose name contains one or more spaces, the attribute must be enclosed in square brackets. (The use of brackets around compound object names is standard for many
16
Function syntax and formula components © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1 objects in MicroStrategy and is not restricted to custom expressions and Apply functions.)
Placing a filter that uses the custom expression above on a report that lists the Customer City, Customer, and Call Center attributes yields the results below. (Only a portion of the report is shown. Also, the Revenue metric has been added.)
Notice that the custom expression qualification filter accomplished the goal of returning only data that satisfies the criterion that the Customer City attribute is the same as the Call Center attribute.
Function parameters
Parameters determine how functions perform calculations. Any function, whether standard or user-defined, can have parameters, which are contained within angle brackets <> in an expression. If more than one parameter is used, they are separated by commas.
Function parameter notations are only displayed in the Desktop interface if the parameter settings are changed from the default and you have set your View option to Show Function Parameters.
You define parameters in the Function Name Parameters dialog box, which displays the tabs Parameters, Break By, and Sort By. For steps on how to access this dialog box and how to set function parameters with the Insert
Function syntax and formula components
17
© 2012 MicroStrategy, Inc.
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
Function Wizard, see
Accessing and modifying function parameters, page 21
.
Since every function object has parameters, the Parameters tab is always displayed. If a function has additional parameters, such as BreakBy and
SortBy, the related tabs are displayed accordingly. The following subsections discuss the three tabs in more detail:
•
•
BreakBy and SortBy parameters, page 19
The details of each function are covered in this guide, including a listing and description of each parameter that is available for the function. All parameters are listed within angle brackets <> as part of the function syntax.
To review the details on the parameters available for each function, review the functions provided in:
•
•
•
Chapter 4, Plug-In Package Functions
Common parameters
There are three common Parameter settings for a function object:
• Distinct
: is a TRUE/FALSE parameter that allows you to use all values or only the unique values in the calculation.
18
Function syntax and formula components © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
• Fact ID
: forces the calculation to take place on a fact table containing the
Fact_ID.
• NULL
: is a TRUE/FALSE parameter that determines if the NULL value can be used in the calculation.
Not all these settings apply to every function. In general, all group-value functions display the FactID Parameter setting. OLAP functions do not have any of these Parameter settings, but they may have BreakBy or SortBy parameters.
BreakBy and SortBy parameters
In addition to the Parameters settings, many functions have BreakBy or
SortBy parameters, each of which has its own individual settings:
• BreakBy:
The logical level where the calculation of values for an expression restarts. To break by an attribute or hierarchy means to restart counting values for expressions that use relative functions.
Examples of relative functions are RunningStdevP, Rank, NTile, and expressions that calculate rank or percent values. The break by level must at the same level of aggregation or a higher level of aggregation used for the expression itself.
For example, in the report shown below the Rank by Value metric ranks the revenue values. The Rank function for this metric uses a BreakBy of the Customer Region attribute, which means the rank calculation is restarted for each customer region. This ensures that the revenue is ranked by customer region, rather than ranking all of the revenues together across customer regions. While ranking all the revenues across
© 2012 MicroStrategy, Inc.
Function syntax and formula components
19
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference customer regions can be useful, this report uses the BreakBy parameter to focus on revenue comparisons within each customer region.
• SortBy
: The order of the return values of an expression in relation to the order of the value or metadata object given. A sort by includes whether to sort in ascending or descending order, and which metadata object to sort by. Sort by may also be performed on the value of the subexpression, which is the input argument.
For example, in the report shown below the FirstInRange metric returns the first profit value in a list of profit values. The FirstInRange function for this metric uses a SortBy of the Customer State attribute, which means the first value for each customer state is returned.
20
Function syntax and formula components © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
OLAP functions often include BreakBy and SortBy parameters. For example,
Rank has a BreakBy parameter, and MovingAvg has a SortBy parameter.
A few group-value functions (First, Last, IRR, and NPV) are also defined by the SortBy parameter. The First and Last functions are used effectively to calculate subtotals (see
For example, an inventory report lists the on-hand supply for each day. The report subtotals are the last day’s inventory. Creating a user-defined subtotal that uses the Last function provides the last day inventory subtotal. If the
SortBy parameters of the function are not set to sort by Day, the function may not provide the correct answer.
Accessing and modifying function parameters
MicroStrategy Desktop provides different methods for accessing and modifying function parameters. You can access and modify function parameters from the following interfaces:
• Insert Function Wizard
: This interface is used to help guide you in the initial inclusion of a function in an expression for a MicroStrategy object.
The Insert Function Wizard can be used to build a function and add it to an expression for metrics, attributes, facts, subtotals, and transformations. For more information, see
Adding functions to expressions with the Insert Function Wizard, page 45
• Function Name Parameters
dialog box: This interface is used to modify the parameters of a function that has been added to an object expression and validated.
To access and modify function parameters with the Insert Function Wizard
1
Open an object editor for a MicroStrategy object that can include functions in its expression.
For steps to access the Insert Function Wizard from the different object editors, refer to the MicroStrategy online help and search for “Steps to access the Insert Function Wizard”. You can also refer
Using functions in expressions, page 27
below that discusses the different types of expressions in MicroStrategy.
Function syntax and formula components
21
© 2012 MicroStrategy, Inc.
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
2
Click the Insert Function button, labeled as f(x) on the expression toolbar.
The Insert Function Wizard opens.
3
Use the Next and Back buttons to step through the pages of the Insert
Function Wizard. Each page allows you to modify different function parameters.
The pages that you see depend on the function that you select.
To access and modify function parameters with the Function Name
Parameters dialog box
This functionality is available in any editor in Desktop where functions are used in expressions. For more information, see the following sections:
•
•
Attribute form expressions, page 34
•
Custom Group expressions, page 38
•
•
•
22
Function syntax and formula components © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
•
Transformation expressions, page 44
1
Insert a function into an object expression and validate the expression.
You can insert a function by writing the name of the function and all required parameters into the expression. You can also insert a
function using the Insert Function Wizard (see the procedure
To build an expression using the Insert Function Wizard, page 46
).
2
Highlight the function name, for example RunningSum, within a validated expression in the expression box.
3
Right-click the function name and select function name parameters, as demonstrated in the image below.
© 2012 MicroStrategy, Inc.
Function syntax and formula components
23
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
The Function Name Parameters dialog box opens. All parameter tabs for the selected function are available, and settings editable, from this dialog.
This example uses the RunningSum function.
Examples of function parameter effects
The following examples briefly illustrate the impact of parameters on function execution.
Example 1: Distinct parameter
Count<Distinct=True>(Order)
In this metric, you modify the default parameter setting to Distinct=True and retrieve a count of only the unique Orders.
Example 2: RunningSum
RunningSum<BreakBy={Quarter}, SortBy=(Region)>(Revenue)
This metric is defined to display the running sum of revenue on a quarterly basis, sorted by region in ascending order. For another RunningSum
OLAP (Relative) functions, page 9
24
Function syntax and formula components © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
Arguments
Arguments are the input data used in the calculation of a function.
Arguments can be numbers, text, or logical values (such as TRUE or FALSE) as well as constants (such as 1, 2, 3, or NULL). They can be lists of values or variables referencing lists of values.
Arguments in MicroStrategy are most often references to lists of values. In function syntax, the arguments are enclosed in parentheses (). If the argument is a reference to a MicroStrategy object, and the object name is alphanumeric or contains multiple words, it is also contained in brackets [ ].
Depending on the function selected and the object being created, in a
MicroStrategy environment the input could comprise one or more of the following objects:
• Attributes
: Attributes are most often used to group fact data. They are included in reports to define the level of detail. Typically non-numeric, some common examples of attributes are Year, Category, and Region.
• Facts
: Facts are the most commonly used input for metrics. They are numerical lists obtained from specific columns in a fact table. Examples of facts include Units Sold, Units Received, and Discount.
• Metrics
: Metrics represent calculations performed on data and can themselves be used as input for further calculation by a function.
Examples of metrics include Percent Growth, Profit Margin, and
Sell-through Percentage.
• Columns
: Column data is used when creating attribute form expressions and fact expressions. The expressions for these objects define how column data is retrieved from the warehouse. Examples of columns include TOT_DOLLAR_SALES, TOT_COST, and CUST_CITY_ID.
For an in-depth discussion of attributes, facts, and metrics, refer to the MicroStrategy Advanced Reporting Guide.
Using prompts for arguments
Prompts can be used to provide the value for an argument in a function, which allows a user to determine part of the function definition when a report is executed. Arguments that expect a single value are the most common arguments to use prompts on. For example, the function NTileSize
(see
NTileSize <Ascending, BreakBy> (Argument, Size)
Function syntax and formula components
25
© 2012 MicroStrategy, Inc.
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
The two arguments for this syntax are:
•
Argument is a metric representing a list of values to be distributed in buckets.
•
Size
is a positive integer that designates the number of elements per bucket.
The argument Size is a good candidate to use a prompt for, since it expects a single value. Using a prompt to provide the value for Size allows a user to determine how many elements should be included in each NTile bucket. This is a more flexible reporting solution than defining a static value for the argument that is always used for the calculation.
To include a prompt in a function expression, you can use the following syntax:
?[Prompt Name]
The Prompt Name is the name of the prompt object. For example, you can have the following definition:
NTileSize([Total Revenue], ?[NTileValue Prompt])
In the syntax shown above, NTileValue Prompt is the name of a value prompt that supplies the size for the NTileSize function.
When prompts are created, you can choose whether answering the prompt is optional or required. Since arguments are required for a function to work properly, it is a good practice to define prompt answers as required if the prompt is going to be used in a function expression.
Many of the financial functions (see
) use arguments that expect a single value, and thus are good candidates for using functions to provide their values. For example, the function Coupdays (see
Coupdays (coupon period, number of days with settlement), page 274
includes a Frequency argument which can accept the value of 1, 2, or 4 to determine the number of coupon payments per year. You could use a value prompt for the Frequency argument to prompt the user to enter the frequency of the coupon payments.
26
Function syntax and formula components © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
Using functions in expressions
Functions are the basis for many MicroStrategy objects. They are used to create:
•
Metric expressions
•
Attribute form expressions
•
Consolidation expressions
•
Custom group expressions
•
Fact expressions
•
Filter expressions
•
Subtotal expressions
•
Transformation expressions
This section explores the various roles of functions for each type of object and how to access the expression builder in each case.
Metric expressions
Metrics are MicroStrategy objects that represent calculations performed on data. You can define metrics by using the available functions to analyze your data and determine business measures.
Formula and dimensionality are the two important components in a metric.
While all metrics have a formula, not all of them have dimensionality.
• Formula:
is the most important part of a metric definition. It is a mathematical expression using one or more functions, applied to the data to be used in the calculation (facts, attributes, constants, or metrics). In
SQL, the formula becomes part of the SELECT clause of the SQL command.
You can use the same formula in multiple metric definitions. This type of formula is called a base formula, which can contain arithmetic operators, attributes, facts, group functions, and non-group functions. For more information, see Base Formulas in the MicroStrategy Advanced
Reporting Guide.
A base formula does not have dimensionality (see below).
Using functions in expressions
27
© 2012 MicroStrategy, Inc.
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
• Dimensionality
: determines the attribute level at which a metric is calculated. After deciding on the target (the attribute), in dimensionality you can further define filtering and grouping involved in the metric. All metrics, by default, calculate at the report level.
Other optional components of a metric include condition (filter) and transformation. For the purposes of this book, we only discuss formula and dimensionality related to the use of functions. For information on all metric components, refer to the MicroStrategy Advanced Reporting Guide.
There are two types of metrics:
•
Simple metric
:
has a formula and dimensionality (level). It can stand alone or be used as a building block for a compound metric. A simple metric must use at least one group-value function, such as Sum or Avg. It can also contain a non-group function or arithmetic operator, in addition to the required group function, for example, Sum(Revenue -
Cost){~+}; however, the outermost formula must be a group function.
•
Compound metric
:
is a combination of expressions that, through the use of functions, are themselves metrics. In other words, a compound metric is made of more than one complete metric. Any metric that is not a simple metric is a compound metric by default. For example, all arithmetic functions that are used as the root to connect two metrics yield compound metrics.
A compound metric cannot have dimensionality placed on the entire metric, although dimensionality can be set separately on each of its component metrics.
A quick way to check whether a metric is simple or compound is through the Metric Editor, where you can click the Subtotals/
Aggregation tab and check if the Allow Smart Totals option is enabled.
If it is, then it is a compound metric; if not, it is a simple metric.
The following three types of functions can be used to build simple and compound metrics:
•
Single-value functions
•
Group-value functions
•
OLAP functions
The optional condition (filter) component of a metric can contain logical and comparison operators. See the Filter Expressions subsection for details.
28
Using functions in expressions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
While the single-value and group-value functions are used to create both simple and compound metrics under different circumstances (see examples to follow), the OLAP functions always yield compound metrics, due to their unique characteristics (see
OLAP (Relative) functions, page 9
).
Examples of dimensionality in metrics
As mentioned previously, all metrics have a formula, but not all metrics have dimensionality. The following examples and diagrams illustrate the formation of simple and compound metrics, as well as formula and dimensionality.
Example 1: Simple metric with dimensionality at the report level
Avg(Revenue) {~+}
In this example, the root of the expression is Avg, and it has one child, the fact Revenue. Together they make up the base formula. This simple aggregation metric has dimensionality, which is indicated by {~+}, meaning that the metric is calculated at the lowest level on the report. For example, if a report contains revenue by year and month, the numbers are calculated to reflect monthly sales data.
All group-value functions are aggregation functions, which, when used alone, yield simple metrics.
Using functions in expressions
29
© 2012 MicroStrategy, Inc.
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
Example 2: Simple metric with dimensionality at Year level
Sum(Cost) {~ +,year +}
In this example, the root of the expression is Sum, and the child is the fact
Cost. Together they make up the base formula. This simple aggregation metric has dimensionality. However, unlike in Example 1, dimensionality is set at the level of the attribute Year, indicated by {Year +}. This means that if a report contains cost by year and month, the numbers are calculated to reflect yearly cost data.
Example 3: Compound metric without dimensionality of its own
Avg(Revenue){~ +}/ Sum(Revenue) {~ +}
30
Using functions in expressions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
In this example, the root Division (/) has two children, Avg(Revenue) and
Sum(Revenue), both of which are simple metrics themselves, and each of which has its own dimensionality. The whole expression itself is a compound metric because it uses two metrics and does not have its own dimensionality.
Example 4: Simple metric with dimensionality of its own
(Avg(Revenue)/Sum(Revenue)) {~+}
In this example, two base formulas are involved by the division (/) function.
Notice that neither of the base formulas has dimensionality of its own. The aggregation takes place at the root level instead of its children’s level. The metric as a whole has its own dimensionality and is a simple metric.
If the two base formulas are replaced by two metrics, then the result will be the same as in Example 3, a compound metric without dimensionality of its own.
Using functions in expressions
31
© 2012 MicroStrategy, Inc.
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
Example 5: Compound metric without dimensionality of its own
Case((Avg(Cost) {~+})>(Sum(Revenue){~+}), 4,5)
In this example, the root is the Case function that has three children: the
Greater Than function (>), 4, and 5. The Greater Than function has two children of its own, Metric 1, Avg(Cost), and Metric 2, AvgRevenue, both of which have dimensionality of their own. The metric itself does not have dimensionality and is a compound metric.
For more information on the Case function, refer to
Accessing metric functions
You can access functions to create metrics in several ways. You can use the
Metric Editor when creating a new metric in a project. To create a derived metric, which is a metric based on the existing data in a report, use the Input
Metric Formula dialog box from within the report.
You can also create metrics in Command Manager. For more information on this method, refer to the MicroStrategy Advanced
Reporting Guide.
32
Using functions in expressions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
Metric Editor
The Metric Editor is used to create new metrics and edit existing metrics in
MicroStrategy. The interface allows you to build metric expressions and validate them.
To access the Metric Editor
1
Log in to a project.
2
In the MicroStrategy Desktop File menu, point to New and then select
Metric
. The New Metric dialog box is displayed.
3
Choose a Metric template and click OK to proceed. The Metric Editor displays.
4
Build the metric expression, accessing the functions in one of the following ways:
•
Expand the Functions and Operators folder using the drop-down list or shortcut list in the Object Browser pane. Then expand the
Functions
, Operators, or Plug-In Packages folder to access the various categories of functions and operators.
•
Click (Insert Function) in the Definition pane. The Insert
Function wizard opens.
•
Type the function name and all required metric syntax directly in the
Enter your formula here
box.
You can also edit existing metrics by using the Metric Editor. To access the editor, select the appropriate metric in the folder list, object browser, or report view. Then right-click and select Edit from the shortcut menu. The Metric Editor opens with the selected metric loaded.
Input Metric Formula dialog box
The Input Metric Formula dialog box is used to create derived metrics, which are created from objects already present in the report.
Using functions in expressions
33
© 2012 MicroStrategy, Inc.
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
To access the Input Metric Formula dialog box
1
From the Insert menu in the Report Editor, select New Metric. Or, right-click above a metric heading in the Report Grid, point to Insert, and then select New Metric in the shortcut menu. The Input Metric Formula dialog box is displayed.
2
Build a metric using the available report objects. Access the functions in one of the following ways:
•
Expand the Functions and Operators folder using the drop-down list or folder list. Then expand the Functions, Operators, or Plug-In
Packages
folder to access the various categories of functions and operators.
•
Click (Insert Function) in the Definition pane. The Insert
Function wizard opens.
•
Type the function name and all required metric syntax directly in the
Enter your formula here
box.
Attribute form expressions
Attribute forms are identifiers or descriptors of an attribute, such as ID,
Name, and Address. These units are part of an attribute, for example,
Customer. Attribute forms are defined by at least one expression, and these expressions act on column data and can contain functions. The types of attribute form expressions are as follows:
•
Simple
•
Implicit
•
Derived
•
Heterogeneous
For more information on these types of attribute forms, refer to the
MicroStrategy Advanced Reporting Guide.
In the context of MicroStrategy functions, this book discusses derived expressions. A derived expression can only use single-value functions, and arguments that are used in the expression are columns. See the examples described below.
34
Using functions in expressions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
Example 1: Subtraction ( - )
(Year(CurrentDate()) - Year([HIRE_DATE]))
The attribute form Employee Experience is defined by the above expression using the simple mathematical operator, subtraction.
This example can be found in the MicroStrategy Tutorial project in the following folder: MicroStrategy Tutorial/Schema Objects/
Attributes/Geography.
Example 2: InitCap
InitCap([CUST_LAST_NAME])
Text data is typically in all upper-case or all lower-case letters. This example shows that for the attribute form of customer’s last name, you can use the single-value function, InitCap, to make the first letter capitalized and all other letters in lower case.
Example 3: ApplySimple
ApplySimple("Datediff(YY,#0,getdate())", [BIRTH_DATE])
The attribute form, Age, can be defined by using the single-value function,
ApplySimple.
Note the following:
•
For all Apply functions, do not use a form group for the attribute form expression. Use a single form because form groups are ignored by the Analytical Engine. For example, you cannot use
Customer@ Name, where Name is defined as the customer’s first name, middle name, and last name.
•
The syntax of apply functions is database-specific. For more
Using functions in expressions
35
© 2012 MicroStrategy, Inc.
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
To access attribute form expressions
For a new attribute
1
From the MicroStrategy Desktop File menu, point to New and then select
Attribute
. The Attribute Editor opens three dialog boxes, if the cascading dialog box option is enabled in the Desktop Preference (as it is by default). The three dialog boxes are New Attribute, Create New Attribute
Form, and Create New Attribute Form Expression. The Create New
Attribute Form Expression dialog box is where functions and operators are used.
2
Build your expression by using the functions in one of the following ways:
•
Click (Insert Function) in the Definition pane. The Insert
Function wizard opens.
•
Type the function name and all required expression syntax directly in the Enter your formula here box.
For an existing attribute
1
To access the editor, select the appropriate attribute in the folder list, object browser, or report view. Then right-click and select Edit from the shortcut menu. The Attribute Editor opens.
2
Select the attribute form you wish to edit from the Attribute Forms pane and then click Modify. The Modify Attribute Form dialog box displays.
To add a new form to the existing Attribute, click New. This automatically opens the New Attribute Form Expression dialog box.
3
Select the expression you wish to edit and click Modify.
To add a new expression to the existing form, click New. This automatically opens the New Attribute Form Expression dialog box.
4
The Modify Attribute Form Expression dialog displays with the selected expression loaded.
36
Using functions in expressions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
5
Create or edit the expression, accessing the functions in one of the following ways:
•
Click (Insert Function) in the Definition pane. The Insert
Function wizard opens.
•
Type/edit the function name and all required expression syntax in the
Enter your formula here
box.
Consolidation element expressions
Consolidations enable you to group attribute elements for use in a report, without changing the structure of your metadata or your warehouse definition. The elements contained in a consolidation are called consolidation elements (CEs). Only single-value functions can be used in the definition of a consolidation element as well as calculations between consolidation elements. A consolidation element expression defines how the attribute elements are calculated.
Only the basic mathematical operators (+, -, *, /) can be used through
MicroStrategy Desktop to define consolidation elements. Examples of consolidations, using these operators, are as follows:
•
CE01 = {Region = North-East}
•
CE02 = {Region = Mid-Atlantic}
•
CE03 = ({CE01} – {CE02})/{CE02}
Other single-value functions can also be used for consolidation elements, but only through the SDK.
The following examples demonstrate definitions using functions and calculations:
•
CE04 = Ln({Region = North-East})
•
CE05 = Ln({Region = Mid-Atlantic})
•
CE06 = Abs({CE04} – {CE05})
For more information on consolidations, see the MicroStrategy
Advanced Reporting Guide.
Using functions in expressions
37
© 2012 MicroStrategy, Inc.
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
To access the consolidation element expressions
1
In the MicroStrategy Desktop File menu, point to New and then select
Consolidation
. The Consolidation Editor opens.
2
Double-click Click here to add new consolidation element.
3
The New Consolidation Element pane is enabled, in the lower right corner of the editor. Build the expression for the new element.
You must drag and drop attributes into the Enter your
expression here
box. Only the operators can be typed directly in the box.
Custom Group expressions
A
custom group
is an object that can be placed on a template and is made up of a collection of elements called custom group elements. A custom group can group attribute elements in a way that is not defined in the data warehouse. You can create relationships between the attribute and the custom group. A custom group expression defines how the elements in the custom group are calculated.
A custom group can organize attribute elements through:
•
Attribute qualification
•
Set qualification
•
A report
•
A filter
•
Banding
•
Advanced qualification
For more information on custom groups, see Custom Groups and
Consolidations in the MicroStrategy Advanced Reporting Guide.
38
Using functions in expressions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
When you define custom group elements through advanced qualification, you can use two types of functions:
•
Logical functions
•
Comparison functions
See the following examples.
Example 1: Subtraction ( - )
([Unit_Profit] - [Unit_Cost]) > 500
Example 2: And
([Units Sold] > 500) and ([Unit Profit] > 1000)
To access the custom group element expressions
1
In the MicroStrategy Desktop File menu, point to New and then select
Custom Group
. The Custom Group Editor opens.
2
Double-click Double-click here or drag an object from the object
browser to add a custom group element
.
3
Provide a name for the new element and double-click Add Qualification.
4
In the Custom Group Options pane, select Add an Advanced
qualification
and click OK.
5
The Advanced Qualification pane opens. This is where the expression is built. The functions are accessed in one of the following ways:
•
Click (Insert Function) in the Definition pane. The Insert
Function wizard opens.
•
Type the function name and all required expression syntax directly in the Enter your formula here box.
© 2012 MicroStrategy, Inc.
Using functions in expressions
39
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
Fact expressions
Facts are objects created by and shared between MicroStrategy users. They relate numeric data values from the data warehouse to the MicroStrategy reporting environment. A fact expression defines how a fact is calculated.
The fact expression is part of the Fact Definition component of a fact structure. You can use functions to create fact expressions, and arguments that are used in the expressions are columns.
Facts can be defined as:
•
Implicit
•
Derived
•
Heterogeneous
For more information on facts and fact structure, see the
MicroStrategy Project Design Guide.
In the context of MicroStrategy functions, this book discusses derived fact expressions.
Derived fact expressions can only use single-value functions, including simple arithmetic operators (+, -, /, *). See the following two examples.
Example 1: Subtraction ( - )
([UNIT_PRICE] - [UNIT_COST])
The fact Unit Profit is defined using the table columns Unit_Price and
Unit_Cost and a simple mathematical operator, subtraction.
Example 2: Multiplication ( * )
([QTY_SOLD] * ([UNIT_PRICE] - DISCOUNT))
The fact Revenue is defined using three table columns and two arithmetic operators, subtraction and multiplication.
Both examples can be found in the MicroStrategy Tutorial project in the following folder: MicroStrategy Tutorial/Schema Objects/Facts.
40
Using functions in expressions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
To access fact expressions
For a new fact with an expression
1
In the MicroStrategy Desktop File menu, point to New and then select
Fact
. The Fact Editor opens two pages: Fact and Create New Fact
Expression.
2
The Expression page is where the expression is built. The functions are accessed in one of the following ways:
•
Click (Insert Function) in the Definition pane. The Insert
Function wizard opens.
•
Type the function name and all required expression syntax directly in the Enter your formula here box.
For an existing fact
1
Select an existing fact in the MicroStrategy Desktop main screen. Then right-click and select Edit from the shortcut menu. The Fact Editor displays with the selected fact loaded.
2
Click New to add a new expression to the fact, or select an existing expression and click Modify. The Create New Fact Expression or
Modify Fact Expression
page displays.
3
Build an expression by using functions in one of the following ways:
•
Click (Insert Function) in the Definition pane. The Insert
Function wizard opens.
•
Type the function name and all required expression syntax directly in the Enter your formula here box.
You can use either the Fact Editor or the Fact Creation Wizard to create facts; however, only the Fact Editor allows you to use advanced expressions to define the fact.
Using functions in expressions
41
© 2012 MicroStrategy, Inc.
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
Filter expressions
A filter specifies the conditions that data must meet to be included in the report results. In SQL, a filter is specified after the WHERE clause. A filter can be a report object, that is, a report filter, a report limit, or a view filter, that restricts the data returned or the display or view of data on a report. For detailed information on report filters, refer to the MicroStrategy Advanced
Reporting Guide.
A filter can also be a metric qualifier created using custom expressions employing functions. It is used as the optional condition component of a metric. You can create this type of filters by using the Advanced Qualification dialog box within the Filter Editor. Only the following types of functions can be used in filter expressions:
•
Logical operators
•
Comparison operators
Single-value functions can be used at the sublevel in a filter expression, as long as the root node is a logical or comparison function (see Example 1).
Example 1: Greater than ( > )
((Revenue - Cost) > “5000”)
This example uses a simple comparison operator to create a filter to limit the display of profit to values greater than $5,000.
You can achieve the same result by using a set (metric) qualification on a compound metric (such as the one in the example defined as
Revenue - Cost). The custom filter expression is used here for illustration purposes. It is up to you which method you prefer to use.
Example 2: ApplyComparison
ApplyComparison("#0 between #1 and #2", ?[Value Prompt
Date], [Order Date]@ID, [Ship Date]@ID)
ApplyComparison is commonly used to create custom filters. In this example, the filter compares a user-entered date to see if it is between the
Order_Date and the Ship_Date.
42
Using functions in expressions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
To access an advanced filter qualification
1
In the MicroStrategy Desktop File menu, point to New and then select
Filter
. The Filter Editor is displayed.
2
In the Filter Definition pane, double-click Double-click here to add a
qualification or drag an object from the Object Browser
. The Filtering
Options pane is displayed.
3
In the Filtering Options pane, select the Add an Advanced qualification option. Then click OK. The Advanced Qualification pane is displayed.
4
Select Custom Expression from the Option list. Then use the Custom
Expression box to build and validate your custom filter. Access the functions in one of the following ways:
•
Expand the Functions and Operators folder using the drop-down list or folder list. Then expand the Functions, Operators, or Plug-In
Packages
folder to access the various categories of functions and operators.
•
Click (Insert Function) in the Definition pane. The Insert
Function Wizard opens.
•
Type the function name and all required metric syntax directly in the
Enter your formula here
box.
Subtotal expressions
Subtotals allow you to dynamically control the computation and display of report data within desired groupings. Subtotals are applied to report metrics to calculate totals and for dynamic aggregation.
The standard predefined subtotal functions, which are automatically available for use with every metric and report, are simple aggregate functions that satisfy many subtotaling requirements. If they do not answer your particular needs, you can create a user-defined subtotal using the Subtotal
Editor or through the SDK. User-defined subtotals allow you to develop your own subtotals, using single-value functions or group-value functions.
© 2012 MicroStrategy, Inc.
Using functions in expressions
43
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
Both predefined and user-defined subtotals can be applied to reports from the Subtotals/Aggregation tab in the Metric Editor.
For more information on subtotals and the procedures for creating and applying them, refer to the Reports chapter of the MicroStrategy
Advanced Reporting Guide or the MicroStrategy online help.
Example: Division ( / )
Sum(Sum(x*[Units Sold]){Year}/Sum([Units Sold]){Year}){}
To access functions in the Subtotal Editor
1
Log in to a project.
2
In the MicroStrategy Desktop File menu, point to New and then select
Subtotal
. The Subtotal Editor displays.
3
The Subtotal Editor is very similar to the Metric Editor. To access the functions used to create a new subtotal, you can do one of the following:
•
Expand the Functions and Operators folder using the drop-down list or shortcut list in the Object Browser pane. Then expand the
Functions
, Operators or Plug-In Packages folder to access the various categories of functions and operators.
•
Click (Insert Function) in the Definition pane. The Insert
Function wizard opens.
•
Type the function name and all required subtotal syntax directly in the
Enter your formula here
box.
Transformation expressions
Transformations are schema objects that use business rules to compare values at different time periods. A typical example of this type of analysis is a
TY/LY comparison (This Year versus Last Year).
Transformations are schema objects; therefore, you must have the appropriate privileges to create or modify them.
44
Using functions in expressions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
There are two types of transformations: expression-based and table-based.
Single-value functions can be used in expression-based transformations, and specifically in the definition of member expressions. These expressions define how (and from where) the information is retrieved for the transformation of the specified attribute.
For more information on transformations and their components, refer to the MicroStrategy Advanced Reporting Guide or the
MicroStrategy online help.
To access functions in transformations
1
In the MicroStrategy Desktop File menu, point to New and then select
Transformation
. The Transformation Editor is displayed. The Select
Member Attribute dialog box also opens.
2
Select the attribute on which to base the transformation. Then click OK.
The Expression Editor opens.
3
Build an expression for the transformation of the selected member attribute, accessing functions in one of the following ways:
•
Click (Insert Function) in the Definition pane. The Insert
Function wizard opens.
•
Type the function name and all required expression syntax directly in the Enter your formula here box.
Adding functions to expressions with the Insert Function
Wizard
The Insert Function Wizard is available wherever functions are used. It guides you through the process of selecting a function, choosing the data on which the function acts, and setting the available parameters.
Using functions in expressions
45
© 2012 MicroStrategy, Inc.
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
To build an expression using the Insert Function Wizard
For detailed information on each page of the Insert Function Wizard, refer to the MicroStrategy online help and search for “Using the Insert
Function Wizard”.
1
Click the Insert Function button to access the wizard. The Select
Function page of the Insert Function Wizard is displayed.
2
Navigate through the folder structure to the function you want to use.
Select the function and click Next to continue. The Arguments page opens.
When a function is highlighted, its syntax and a short description are displayed in the lower left corner of the window.
3
Include the arguments for your function by typing the values or names of the arguments or by browsing for the arguments:
•
Type the appropriate values or name of the arguments into the available boxes.
46
Using functions in expressions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
•
Click (the Browse button). The Open dialog box opens, which is a standard Windows dialog box for file selection.
Select the argument on which the function acts. Click open to select the argument and return to the Insert Function Wizard.
4
Click Next when you have provided all arguments. The Parameters page is displayed (if applicable).
For group-value metrics such as Count, Min, and Max, standard parameters (Distinct, NULL, and FactID) display together on the only page available, called Parameters. The default for FactID is (Nothing), meaning that the calculation searches for the input argument from the lookup table. Otherwise, make a selection from the pull-down list to force the calculation to look in another table.
5
Set the values of the parameters.
6
Define the SortBy and BreakBy parameters in their separate windows, if applicable.
7
Click Finish. The expression built through the Insert Function Wizard displays in the appropriate editor.
Parameter values are displayed only if you have set your view to
Show Function Parameters
and have modified a parameter from its default setting.
Using functions in expressions
47
© 2012 MicroStrategy, Inc.
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
How MicroStrategy processes functions
MicroStrategy Intelligence Server has an engine component, which comprises the following:
• SQL Engine
: Generates the SQL and associated logic for functions performed by the database, and communicates with the Analytical
Engine as necessary.
• Query Engine
: Sends the SQL generated by the SQL Engine to the data warehouse for execution.
• Analytical Engine
: Extends the capability of the system beyond what the
RDBMS provides. For example, it performs complex calculations on a result set returned from the data warehouse, such as statistical and financial functions, subtotal calculations on the result set, metric calculations that are not or cannot be performed using SQL, such as complex functions, and so on.
While this extends the capabilities of the RDBMS that you are using, calculations that require the Analytical Engine can require additional system resources and processing time. To determine if a function is supported by your RDBMS or will be evaluated by the Analytical Engine,
review the function support listed in
Database Support for Functions
.
Types of function processing
Functions supported by the Intelligence Server are of three types:
•
Those that can be processed only by the Analytical Engine, such as finance functions.
If the Analytical Engine does not support a given function, a compound metric containing the function cannot be smart metric enabled. This is because smart metrics change the default order of metric evaluation and only the Analytical Engine can support such a change.
•
Those that can be processed only by the database, such as date-and-time functions.
If a database platform does not support a given function that can only be processed by the database, that function cannot be calculated. For a list of
functions supported for each certified database type, see
MicroStrategy and Database Support for Functions
.
48
How MicroStrategy processes functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
•
Those that can be processed either by the Analytical Engine or by the database.
If the database can perform the calculation, the SQL Engine sends the instructions to the database; otherwise, the Analytical Engine processes the task.
How Intelligence Server uses functions
Recall that there are several categories of functions recognized by
Intelligence Server. These function types include group-value, single-value, and OLAP functions. Within these categories are functions supported by only the Analytical Engine, only the database, or by both the engine and the database. The SQL generated to process the request differs depending on what processes the request. The SQL syntax also differs depending on the database used, when the database supports the function.
The following subsections explore through examples of how the various uses of functions result in different SQL syntax. All of these examples use the functions in the context of metrics.
Most of these examples (except where noted) can be recreated using the objects in the MicroStrategy Tutorial. Tutorial data is stored in a
Microsoft® Access database.
Using group-value functions
The computation of group-value functions is done by either the Intelligence
Server or the database depending upon the function used and support available. The following examples discuss how MicroStrategy performs the group-value computations by providing the SQL syntax for specific situations.
Group-value functions in simple metrics
This subsection contains two examples that illustrate the processing of group-value functions. Each example contains two reports, the first one showing the SQL for a function supported by the database and the second one by the Analytical Engine.
How MicroStrategy processes functions
49
© 2012 MicroStrategy, Inc.
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
Example 1: Sum(Revenue) vs. AvgDev(Revenue)
Consider a simple report, Report 1A, where the attribute Region is placed on the row axis and a simple metric defined as M1A=Sum(Revenue){~} is on the column axis. This report shows the sales for each region. The database, in this case Microsoft Access, supports the function Sum. The following SQL is generated:
•
Report 1A (SQL Group-value function) - Microsoft Access select a12.[REGION_ID] AS REGION_ID, max(a13.[REGION_NAME]) AS REGION_NAME, sum(a11.[TOT_DOLLAR_SALES]) AS WJXBFS1 from [CITY_CTR_SLS] a11,
[LU_CALL_CTR] a12,
[LU_REGION] a13 where a11.[CALL_CTR_ID] = a12.[CALL_CTR_ID] and a12.[REGION_ID] = a13.[REGION_ID] group by a12.[REGION_ID]
Now, consider Report 1B, again with the same attribute, Region, on the row axis, but with a different simple metric defined as M1B=
AvgDev(Revenue){~} on the column axis. This report shows how revenue data varies from its mean for each region. The database does not support the function Average Deviation; therefore, the computation is performed by the
Analytical Engine. The following SQL is generated:
•
Report 1B (MicroStrategy Group-value function) select a11.[CALL_CTR_ID] AS CALL_CTR_ID, a11.[CUST_CITY_ID] AS CUST_CITY_ID, a12.[REGION_ID] AS REGION_ID, a13.[REGION_NAME] AS REGION_NAME, a11.[TOT_DOLLAR_SALES] AS WJXBFS1 from [CITY_CTR_SLS] a11,
[LU_CALL_CTR] a12,
[LU_REGION] a13 where a11.[CALL_CTR_ID] = a12.[CALL_CTR_ID] and a12.[REGION_ID] = a13.[REGION_ID]
[An analytical SQL]
In Report 1B, Intelligence Server performs the following steps:
•
It retrieves all fact data from the warehouse. [TOTAL_ DOLLAR_SALES] is the column alias used for the fact (Revenue) in the temporary table during SQL generation.
50
How MicroStrategy processes functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
•
It uses the result set (that is held in memory) to compute the metric, namely AvgDev([TOTAL_ DOLLAR_SALES]){~} for each region.
The notation [An analytical SQL] indicates that the computation is taking place in the Analytical Engine.
•
It displays the final result.
In the previous examples, the dimensionality of both metrics is defined as
{~}, which means that they both are calculated at the report level of Region, since attribute Region is on the reports.
The next example explains how Intelligence Server processes dimensionality.
When metric dimensionality is defined, the Analytical Engine can insert records back into the temporary database structures after the function calculation is performed so that dimensionality can be applied.
Example 2: Sum(Revenue) {~, Country} vs. AvgDev(Revenue) {~, Country}
Now use the same report template as in Example 1, but add a dimensionality to each metric for comparison. Use Sum(Revenue){~,Country} for
Report 2A and AvgDev(Revenue){~,Country} for Report 2B. Notice that attribute Country is a parent of Region, and the relationship is one to many. In Report 2A, the Sum function is supported by the database; in
Report 2B, the AvgDev function is supported by Intelligence Server. The SQL generated for both reports is as follows:
Report 2A (SQL Group-value function) - Microsoft Access
create table ZZT1Y03009ZMD000 (
COUNTRY_ID BYTE,
WJXBFS1 DOUBLE) insert into ZZT1Y03009ZMD000 select a12.[COUNTRY_ID] AS COUNTRY_ID, sum(a11.[TOT_DOLLAR_SALES]) AS WJXBFS1 from [CITY_CTR_SLS] a11,
[LU_CALL_CTR] a12 where a11.[CALL_CTR_ID] = a12.[CALL_CTR_ID] group by a12.[COUNTRY_ID] select a11.[REGION_ID] AS REGION_ID, a11.[REGION_NAME] AS REGION_NAME, pa1.[WJXBFS1] AS WJXBFS1 from [ZZT1Y03009ZMD000] pa1,
How MicroStrategy processes functions
51
© 2012 MicroStrategy, Inc.
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
[LU_REGION] a11 where pa1.[COUNTRY_ID] = a11.[COUNTRY_ID] drop table ZZT1Y03009ZMD000
The first pass of SQL creates a temporary table to hold the data. The second pass computes the metric at the Country level, while the third pass joins with attribute Region since the result of the aggregation has to be displayed for each region. The final pass drops the temporary table.
Report 2B (MicroStrategy Group-value function)
select a11.[CUST_CITY_ID] AS CUST_CITY_ID, a12.[COUNTRY_ID] AS COUNTRY_ID, a11.[CALL_CTR_ID] AS CALL_CTR_ID, a11.[TOT_DOLLAR_SALES] AS WJXBFS1 from [CITY_CTR_SLS] a11,
[LU_CALL_CTR] a12 where a11.[CALL_CTR_ID] = a12.[CALL_CTR_ID] create table ZZMD00 (
COUNTRY_ID BYTE,
WJXBFS1 FLOAT)
[An analytical SQL] insert into ZZMD00 values ([DummyInsertValue]) select a11.[REGION_ID] AS REGION_ID, a11.[REGION_NAME] AS REGION_NAME, pa1.[WJXBFS1] AS WJXBFS1 from [ZZMD00] pa1,
[LU_REGION] a11 where pa1.[COUNTRY_ID] = a11.[COUNTRY_ID] drop table ZZMD00
In Report 2B, an Analytical SQL pass is necessary to compute AvgDev since it is not a database supported group-value function. In the next pass, the results of the calculation are inserted back into the temporary database structures. The last SQL pass is the same as Report 2A, since it is used to display the result for all regions.
52
How MicroStrategy processes functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
Using single-value functions
The key to understanding the computation of a single-value function is to identify the way it is used. The next two subsections provide examples of the two uses of single-value functions and how they are processed.
The first example shows a single-value function applied before a group-value function. This is referred to as transforming a fact. The second example shows a single-value function applied after the group-value function. This is referred to as a compound metric.
Each example contains two reports, the first one showing the SQL syntax when calculations are processed by the database and the second one when calculations are processed by the Intelligence Server.
The use of transform in this context refers to retrieving a fact in a different form. For example, you can obtain the absolute value for a fact or the natural logarithm, but the fact is the same. This differs from a transformation where the data retrieved is different when a transformation is applied, for example, last year’s revenue instead of this year’s revenue.
Transforming a fact into another fact
In this case, the fact Revenue is transformed into another fact, namely the natural logarithm values defined as Ln(Revenue) or the truncated revenue values defined as Trunc(Revenue).
The following example describes this type of usage and displays the SQL that is generated.
Consider the two metrics defined as follows:
•
M3A = Sum(Ln(Revenue)){~+}
•
M3B = Sum(Trunc(Revenue)){~+}
Put M3A with Region on the template. The database, in this case, SQL Server
2000, supports the function Ln. The following SQL is generated:
Report 3A (SQL single-value before group-value function) - SQL Server 2000
Pass0 - Duration: 0:00:40.45
select a13.REGION_ID REGION_ID,
How MicroStrategy processes functions
53
© 2012 MicroStrategy, Inc.
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference max(a14.REGION_NAME) REGION_NAME, sum(LOG(a11.ORDER_AMT)) WJXBFS1 from ORDER_FACT a11 join LU_EMPLOYEE a12
on (a11.EMP_ID = a12.EMP_ID) join LU_CALL_CTR a13
on (a12.CALL_CTR_ID = a13.CALL_CTR_ID) join LU_REGION a14
on (a13.REGION_ID = a14.REGION_ID) group by a13.REGION_ID
Based on the SQL, this is what happened:
1
The Ln function is applied to the fact Revenue, which is defined in the warehouse by the column ORDER_AMT.
The Ln function uses the syntax LOG in SQL Server 2000.
2
Then, the Sum function is performed on the new fact, namely
Ln(Revenue).
Now, put M3B with Region on the template, the following SQL is generated:
Report 3B (MicroStrategy single-value before group-value function)
select a11.[CALL_CTR_ID] AS CALL_CTR_ID, a11.[CUST_CITY_ID] AS CUST_CITY_ID, a12.[REGION_ID] AS REGION_ID, a13.[REGION_NAME] AS REGION_NAME, a11.[TOT_DOLLAR_SALES] AS WJXBFS1 from [CITY_CTR_SLS] a11,
[LU_CALL_CTR] a12,
[LU_REGION] a13 where a11.[CALL_CTR_ID] = a12.[CALL_CTR_ID] and a12.[REGION_ID] = a13.[REGION_ID]
[An Analytical SQL]
In this case, as noted by the text [An Analytical SQL], the functions
Trunc and Sum are computed by the Intelligence Server. Intelligence Server computes the new fact Trunc([Dollar Sales]) first and then uses the
Sum function to sum the new fact for each region.
54
How MicroStrategy processes functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
Calculating a compound metric
Single-value functions can be used to create compound metrics. Subtraction, addition, division, and multiplication operators (–, +, /, *) are common examples of single-value functions. See the following examples:
•
(Sum([Dollar Sales]){~}/Sum([Dollar Sales])
{~,Country})
•
(Sum([Dollar Sales]){~} + Sum([Freight]) {~})
The examples below use a compound metric and a metric that transforms a fact in the same report. The examples illustrate the SQL generated when the function is supported by the database and the Intelligence Server, respectively.
Consider the following metric definitions:
•
M4A = Ln(Sum(Revenue){~})
•
M4B = Trunc(Sum(Revenue){~})
Put metric M3A, from the previous example, and metric M4A together with attribute Region on the template. The database, in this case SQL Server
2000, supports the Ln function. The following SQL is generated:
Report 4A (SQL single-value before and after group-value functions) - SQL
Server 2000
Pass0 - Duration: 0:00:02.58
select a13.REGION_ID REGION_ID, max(a14.REGION_NAME) REGION_NAME, sum(LOG(a11.ORDER_AMT)) WJXBFS1,
LOG(sum(a11.ORDER_AMT)) WJXBFS2 from ORDER_FACT a11 join LU_EMPLOYEE a12
on (a11.EMP_ID = a12.EMP_ID) join LU_CALL_CTR a13
on (a12.CALL_CTR_ID = a13.CALL_CTR_ID) join LU_REGION a14
on (a13.REGION_ID = a14.REGION_ID) group by a13.REGION_ID
To process metric M3A, the single-value function Ln is calculated before the group-value function Sum, and for metric M4A, Ln is calculated after Sum.
The Ln function uses the syntax LOG in SQL Server 2000.
How MicroStrategy processes functions
55
© 2012 MicroStrategy, Inc.
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
Similarly, if you put metrics M3B and M4B together with attribute Region on the template, and the database does not support the Trunc function, then the following SQL is generated:
Pass0 - Duration: 0:00:12.67
select a11.ORDER_DATE DAY_DATE, a11.EMP_ID EMP_ID, a11.ORDER_ID ORDER_ID, a13.REGION_ID REGION_ID, a14.REGION_NAME REGION_NAME, a11.ORDER_AMT WJXBFS1 from ORDER_FACT a11 join LU_EMPLOYEE a12
on (a11.EMP_ID = a12.EMP_ID) join LU_CALL_CTR a13
on (a12.CALL_CTR_ID = a13.CALL_CTR_ID) join LU_REGION a14
on (a13.REGION_ID = a14.REGION_ID)
Pass1 - Duration: 0:00:08.46
[An Analytical SQL]
The fact, Revenue, which is defined as column ORDER_AMT in the
ORDER_FACT table, is retrieved and used to compute both metrics.
Using OLAP functions
You can better understand how Intelligence Server computes OLAP functions by observing several examples based on the following properties:
•
Window size
•
BreakBy
•
SortBy
•
NULL handling
•
Tie handling
There are two examples for each subsection, comparing the SQL syntax when the database performs the OLAP function calculations with the one when the
Intelligence Server performs the computation.
56
How MicroStrategy processes functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
Window Size in Moving functions
For this example, define metric M1A as Sum(Revenue){~+}. Then create an OLAP metric called OM1, that is defined as
MovingAvg <BreakBy = {Category}, SortBy =
(Value)>([M1A],5).
OM1 computes the moving average of M1A with a window size of 5. The
OLAP metric is computed after it is sorted by the value of M1A in ascending order. Moreover, the computation restarts for every category.
Now, put the attributes Category and Item on the Row axis and the above metrics on the Column axis. Run this report with an empty filter against a database that does not support OLAP functions (in this case Microsoft
Access), the following SQL is generated:
Report 5A (MicroStrategy OLAP function - window size) - Microsoft Access
Pass0 - Duration: 0:00:00.60
select a13.[CATEGORY_ID] AS CATEGORY_ID, max(a14.[CATEGORY_DESC]) AS CATEGORY_DESC, a11.[ITEM_ID] AS ITEM_ID, max(a12.[ITEM_NAME]) AS ITEM_NAME, sum(a11.[TOT_DOLLAR_SALES]) AS WJXBFS1 from [ITEM_MNTH_SLS] a11,
[LU_ITEM] a12,
[LU_SUBCATEG] a13,
[LU_CATEGORY] a14 where a11.[ITEM_ID] = a12.[ITEM_ID] and a12.[SUBCAT_ID] = a13.[SUBCAT_ID] and a13.[CATEGORY_ID] = a14.[CATEGORY_ID] group by a13.[CATEGORY_ID], a11.[ITEM_ID]
Pass1 - Duration: 0:00:00.01
[An Analytical SQL]
Alternatively, if you execute the above report against a database that does support OLAP computations (in this case Oracle 9i), then the following SQL is generated:
Report 5B (DB OLAP function - window size) - Oracle 9i
Pass0 - Duration: 0:00:10.15
© 2012 MicroStrategy, Inc.
How MicroStrategy processes functions
57
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference select a13.CATEGORY_ID CATEGORY_ID, a14.CATEGORY_DESC CATEGORY_DESC, a11.ITEM_ID ITEM_ID, a12.ITEM_NAME ITEM_NAME, sum((a11.QTY_SOLD * (a11.UNIT_PRICE - a11.DISCOUNT)))
WJXBFS1, avg(sum((a11.QTY_SOLD * (a11.UNIT_PRICE a11.DISCOUNT)))) over(partition by a13.CATEGORY_ID
order by sum((a11.QTY_SOLD * (a11.UNIT_PRICE a11.DISCOUNT))) asc rows 4 preceding) WJXBFS2 from ORDER_DETAIL a11,
LU_ITEM a12,
LU_SUBCATEG a13,
LU_CATEGORY a14 where a11.ITEM_ID = a12.ITEM_ID and a12.SUBCAT_ID = a13.SUBCAT_ID and a13.CATEGORY_ID = a14.CATEGORY_ID
group by a13.CATEGORY_ID, a14.CATEGORY_DESC, a11.ITEM_ID, a12.ITEM_NAME
The following example shows how the Intelligence Server computes OLAP functions when the database does not support OLAP functions. The
Intelligence Server retrieves all components: the input metric, BreakBy parameter, and SortBy parameter. In the above examples, since the SortBy parameter setting is by Value, it is sufficient to bring back just the input metric (
WJXBFS1
).
BreakBy in OLAP functions
In the Intelligence Server, the BreakBy parameter is only available at the attribute level. In other words, you can start over certain computations of
OLAP functions when a part of the metric belongs to a different attribute element.
In the previous example (window size), there is an OLAP function with
Category in the BreakBy parameter. If the Analytical Engine computes the
OLAP function, Intelligence Server must select this attribute in the select clause. If the database computes the OLAP function, then this attribute must also be in the partition by clause.
Attributes in the BreakBy parameter of an OLAP metric are always applied, meaning that they are always in the Select clause, and if the
58
How MicroStrategy processes functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1 database computes it, they are also in the Partition by clause. This is true whether the attribute is on the template or not.
Run a report similar to the one for window size, deleting the attributes
Category and Item from the template and adding Subcategory. The results for metric M1A are completely different from the previous report because if
Category and Item are not on the template, then the level of aggregation for metric M1A is replaced by Subcategory, which is on the template. On the other hand, OLAP metric OM1 must still restart the calculation (break by) for each Category and therefore remains in the appropriate Select and
Partition by clauses. Notice that in both the SQLs below, the Intelligence
Server always selects Category even though Category is not on the template.
For a database that does not support OLAP functions (in this case Microsoft
Access), the following SQL is generated:
Report 6A (MicroStrategy OLAP function <BreakBy>) - Microsoft Access
Pass0 - Duration: 0:00:00.63
select a11.[SUBCAT_ID] AS SUBCAT_ID, max(a12.[SUBCAT_DESC]) AS SUBCAT_DESC, a12.[CATEGORY_ID] AS CATEGORY_ID, sum(a11.[TOT_DOLLAR_SALES]) AS WJXBFS1 from [CITY_SUBCATEG_SLS] a11,
[LU_SUBCATEG] a12 where a11.[SUBCAT_ID] = a12.[SUBCAT_ID] group by a11.[SUBCAT_ID], a12.[CATEGORY_ID]
Pass1 - Duration: 0:00:00.00
[An Analytical SQL]
If the database supports computation of OLAP functions (in this example
Oracle), then the following SQL is generated:
Report 6B (DB OLAP function) - Oracle
Pass0 - Duration: 0:00:09.39
select a12.SUBCAT_ID SUBCAT_ID, a13.SUBCAT_DESC SUBCAT_DESC, a13.CATEGORY_ID CATEGORY_ID, sum((a11.QTY_SOLD * (a11.UNIT_PRICE - a11.DISCOUNT)))
WJXBFS1, avg(sum((a11.QTY_SOLD * (a11.UNIT_PRICE a11.DISCOUNT)))) over(partition by a13.CATEGORY_ID
© 2012 MicroStrategy, Inc.
How MicroStrategy processes functions
59
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference order by sum((a11.QTY_SOLD * (a11.UNIT_PRICE a11.DISCOUNT))) asc rows 4 preceding) WJXBFS2 from ORDER_DETAIL a11,
LU_ITEM a12,
LU_SUBCATEG a13 where a11.ITEM_ID = a12.ITEM_ID and a12.SUBCAT_ID = a13.SUBCAT_ID
group by a12.SUBCAT_ID, a13.SUBCAT_DESC, a13.CATEGORY_ID
Sorting in OLAP functions
For OLAP functions, sorting is done before performing computations.
Basically, there are two choices for the SortBy parameter setting:
• Sort by Value in Subexpression
: See Reports 5B (in
OLAP function - window size) - Oracle 9i, page 57
(DB OLAP function) - Oracle, page 59
) for examples. Note that if the
database can perform computation of OLAP functions, then the definition of the subexpression M1A displays in the order by clause.
For example, the above reports contain: “order by sum((a11.QTY_SOLD * (a11.UNIT_PRICE - a11.DISCOUNT))) asc” to represent the <SortBy = Value ascending> parameter setting.
• Sort by Objects
: This type of sorting can use either attributes or metrics.
The following examples demonstrate the differences in processing when an attribute or metric is used.
In this example, the OLAP metric is sorted by a normal attribute (either by
ID or Desc).
Create an OLAP metric defined as:
OM2 = RunningSum<BreakBy = {[Customer Region]}, SortBy =
([Customer City]@ID asc, Customer@Name dsc)>([M1A])
Then add the attributes Customer Region and Customer, and the metric
OM2 to the template.
The metric OM2 is sorted by Customer City@ID in ascending order, then by
Customer@Name in descending order, though the attribute Customer City is not on the template. Assume that attribute Customer is a child of the attribute Customer City, and Customer City is a child of Customer Region.
60
How MicroStrategy processes functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
For a database that does not support OLAP functions (in this case Microsoft
Access), the following SQL is generated:
Report 7A (MicroStrategy OLAP function <SortBy>) - Microsoft Access
select a14.[CUST_REGION_ID] AS CUST_REGION_ID, a15.[CUST_REGION_NAME] AS CUST_REGION_NAME, a11.[CUSTOMER_ID] AS CUSTOMER_ID, a12.[CUST_LAST_NAME] AS CUST_LAST_NAME, a12.[CUST_FIRST_NAME] AS CUST_FIRST_NAME, a12.[CUST_CITY_ID] AS CUST_CITY_ID, a11.[TOT_DOLLAR_SALES] AS WJXBFS1 from [CUSTOMER_SLS] a11,
[LU_CUSTOMER] a12,
[LU_CUST_CITY] a13,
[LU_CUST_STATE] a14,
[LU_CUST_REGION] a15 where a11.[CUSTOMER_ID] = a12.[CUSTOMER_ID] and a12.[CUST_CITY_ID] = a13.[CUST_CITY_ID] and a13.[CUST_STATE_ID] = a14.[CUST_STATE_ID] and a14.[CUST_REGION_ID] = a15.[CUST_REGION_ID]
[An Analytical SQL]
If the database supports computation of OLAP functions (in this example
Oracle 9i), the following SQL is generated:
Report 7B (DB OLAP function <SortBy>) - Oracle
Pass0 - Duration: 0:00:15.00
select a15.CUST_REGION_ID CUST_REGION_ID, a16.CUST_REGION_NAME CUST_REGION_NAME, a12.CUSTOMER_ID CUSTOMER_ID, a13.CUST_LAST_NAME CUST_LAST_NAME, a13.CUST_FIRST_NAME CUST_FIRST_NAME, a13.CUST_CITY_ID CUST_CITY_ID, sum(sum(a11.ORDER_AMT)) over(partition by a15.CUST_REGION_ID order by a13.CUST_CITY_ID asc, a13.CUST_LAST_NAME desc, a13.CUST_FIRST_NAME desc rows unbounded preceding) WJXBFS1 from ORDER_FACT a11,
LU_ORDER a12,
LU_CUSTOMER a13,
LU_CUST_CITY a14,
LU_CUST_STATE a15,
LU_CUST_REGION a16
© 2012 MicroStrategy, Inc.
How MicroStrategy processes functions
61
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference where a11.ORDER_ID = a12.ORDER_ID and a12.CUSTOMER_ID = a13.CUSTOMER_ID and a13.CUST_CITY_ID = a14.CUST_CITY_ID and a14.CUST_STATE_ID = a15.CUST_STATE_ID and a15.CUST_REGION_ID = a16.CUST_REGION_ID
group by a15.CUST_REGION_ID, a16.CUST_REGION_NAME, a12.CUSTOMER_ID, a13.CUST_LAST_NAME, a13.CUST_FIRST_NAME, a13.CUST_CITY_ID
In both SQLs, the Intelligence Server selects a13.CUST_CITY_ID, even though attribute Customer City is not on the report. In Report 7B, this attribute is also in the group by clause. Sort by attribute Customer City@ID is done because of attribute Customer that is a child of Customer City.
In Report 7B, the SQL has to issue group by CUST_LAST_NAME and
CUST_FIRST_NAME due to the sort by Customer@Name. For optimization purposes, the Intelligence Server only groups by the ID column.
There is a VLDB setting that allows you to group by non-ID columns.
This VLDB setting can be set for any report that uses an OLAP metric with a sort by attribute description.
In this example, an OLAP metric is sorted by an attribute and a metric.
Create an OLAP metric defined as:
OM3 = RunningSum<BreakBy = {[Customer Region]}, SortBy =
(Customer@[Last Name] desc, [M1A] asc)>([M1A])
Then add attributes Customer Region and Customer, and metric OM3 to the template. The OLAP metric OM3 is sorted by Customer Last Name and then by the metric [M1A].
For databases that do not support OLAP functions (in this case Microsoft
Access), the following SQL is generated:
Report 8A (MicroStrategy OLAP function <SortBy>) - Microsoft Access
Pass0 - Duration: 0:00:00.47
select a14.[CUST_REGION_ID] AS CUST_REGION_ID, a15.[CUST_REGION_NAME] AS CUST_REGION_NAME, a11.[CUSTOMER_ID] AS CUSTOMER_ID, a12.[CUST_LAST_NAME] AS CUST_LAST_NAME,
62
How MicroStrategy processes functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1 a12.[CUST_FIRST_NAME] AS CUST_FIRST_NAME, a11.[TOT_DOLLAR_SALES] AS WJXBFS1 from [CUSTOMER_SLS] a11,
[LU_CUSTOMER] a12,
[LU_CUST_CITY] a13,
[LU_CUST_STATE] a14,
[LU_CUST_REGION] a15 where a11.[CUSTOMER_ID] = a12.[CUSTOMER_ID] and a12.[CUST_CITY_ID] = a13.[CUST_CITY_ID] and a13.[CUST_STATE_ID] = a14.[CUST_STATE_ID] and a14.[CUST_REGION_ID] = a15.[CUST_REGION_ID] and a14.[CUST_REGION_ID] in (3, 7)
Pass1 - Duration: 0:00:00.06
[An Analytical SQL]
If the database supports computation of OLAP functions (in this example
Oracle), the following SQL is generated:
Report 8B (DB OLAP function <SortBy>) - Oracle
select a15.CUST_REGION_ID CUST_REGION_ID, a16.CUST_REGION_NAME CUST_REGION_NAME, a12.CUSTOMER_ID CUSTOMER_ID, a13.CUST_LAST_NAME CUST_LAST_NAME, a13.CUST_FIRST_NAME CUST_FIRST_NAME, sum(a11.ORDER_AMT) WJXBFS1, sum(sum(a11.ORDER_AMT)) over(partition by a15.CUST_REGION_ID order by a13.CUST_LAST_NAME desc, sum(a11.ORDER_AMT) desc rows unbounded preceding)
WJXBFS2 from ORDER_FACT a11,
LU_ORDER a12,
LU_CUSTOMER a13,
LU_CUST_CITY a14,
LU_CUST_STATE a15,
LU_CUST_REGION a16 where a11.ORDER_ID = a12.ORDER_ID and a12.CUSTOMER_ID = a13.CUSTOMER_ID and a13.CUST_CITY_ID = a14.CUST_CITY_ID and a14.CUST_STATE_ID = a15.CUST_STATE_ID and a15.CUST_REGION_ID = a16.CUST_REGION_ID
and a15.CUST_REGION_ID in (7, 3) group by a15.CUST_REGION_ID, a16.CUST_REGION_NAME, a12.CUSTOMER_ID,
© 2012 MicroStrategy, Inc.
How MicroStrategy processes functions
63
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference a13.CUST_LAST_NAME, a13.CUST_FIRST_NAME
NULL handling in OLAP functions
When sorted by Intelligence Server, NULL is placed at the end of a list.
Databases also put NULL at the end, as required by the ANSI standard.
For RunningCount or MovingCount functions, NULL is always ignored. For other computations, such as RunningSum or MovingAvg, NULL is treated as zero for the sum of values across the function parameters. This behavior is consistent for Intelligence Server and ANSI-compliant database OLAP functions.
Tie handling in OLAP functions
Tie Handling is related to the SortBy parameter when you sort a tie in a metric. Intelligence Server uses a Merge-Sort algorithm, which always preserves the original order retrieved from the database (via ODBC) to the
Intelligence Server.
It is not known whether databases use the same sort algorithm; therefore, the Intelligence Server and database computation of OLAP functions can produce different results whenever there is a tie on the data.
Using custom plug-in functions
Function Plug-Ins in the MicroStrategy Engine allow users to define their own collection of functions, and then let the Engine use them for further analysis. The plug-in functions, usually called user-defined functions, behave as if they are an integrated part of the MicroStrategy product and are indistinguishable from all other MicroStrategy functions or operators, such as Sum, Average, Min, Max, Count, -, +, /, or *. The Intelligence Server performs standard computations such as Sum, Average, +, /, and so on that are usually calculated by the database.
The MicroStrategy product is equipped with approximately 250 functions and operators, about 130 of which are predefined plug-in functions created by MicroStrategy. They are intended to provide three full-featured libraries of functions that are most commonly used by customers— financial functions, math functions, and statistical functions. Examples include
Accrint, IRR, NPV, Abs, Ln, Log, AvgDev, HomoscedasticTTest, and
64
How MicroStrategy processes functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
Confidence, and so on. These functions are located at ...Schema Objects/
Functions and Operators/Plug-In Packages.
For detailed information on individual functions, refer to
Plug-In Package Functions
and the Function Plug-in Wizard online
help.
Creating user-defined plug-in functions
Using the MicroStrategy Function Plug-In Wizard, you can define custom functions relevant to your business case scenarios. You can create individual functions or even entire function packages, such as the financial, mathematical, and statistical packages, provided by MicroStrategy. Guided by the wizard, you start by creating a Microsoft Visual C++ project with placeholders where you can add custom analytic code. After the new plug-in function is created, you need to launch MicroStrategy Desktop to import it so it can be used for all the reports. As mentioned previously, once a function is imported, it will be used in the same way as any other standard
MicroStrategy function.
For instructions on creating a plug-in function, refer to the Function
Plug-in Wizard online help.
The main stages of the creation process are described as follows:
• Designing
: determines how to implement the analytical procedures into a computer algorithm.
• Creating
: creates the Microsoft Visual C++ project, which is used to build a library containing your algorithms.
• Implementing
: creates the code that embodies the algorithms and compiling this code into a library that is used by MicroStrategy.
• Importing
: adds the library to a MicroStrategy project so that its algorithms are available for use in the project.
• Executing
: creates new metrics that use the algorithms and using those metrics in a MicroStrategy report.
You can create the following types of functions:
•
Single-value functions
•
Group-value functions
•
OLAP functions
How MicroStrategy processes functions
65
© 2012 MicroStrategy, Inc.
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
The datatypes of input arguments can be:
•
Numeric
•
Date
•
String
A plug-in function can contain more than one parameter. Supported datatypes for parameters include:
•
Byte
•
Short
•
Long
•
Float
•
Double
•
String (BSTR)
•
Bool
•
Date
The following two examples illustrate how plug-in functions could be defined:
•
FORECAST<n>(numeric_vector1) = numeric1
Aggregate function with a numeric vector as an input argument and a numeric scalar as an output argument
One parameter, n, which is a long integer
Given a series of values each one time interval apart, predicts the value after n additional time intervals
Example: FORECAST<2>(100,120,140,160) = 200
•
CUSTOMNUMBERFORMAT(numeric1) = string1
Simple function with numeric scalar as input argument and string scalar as output argument
No parameters
66
How MicroStrategy processes functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
Transforms a number into a string representation of that number not supported by any of MicroStrategy's out-of-the-box metric format strings
Example: CUSTOMNUMBERFORMAT(123456789) = '1 2345.6789'
To install the Function Plug-In Wizard
1
From ...\MicroStrategy\Desktop, click FPWizard.exe.
2
Follow the prompts to install.
To activate the Function Plug-In Wizard
1
From the Start button, select Programs, then Microsoft Visual Studio, and then Microsoft Visual C++. The InstallShield window is displayed.
2
From the File menu, select New. The New window is displayed.
3
On the Projects tab, select MicroStrategy Function Plug-in Wizard.
4
Provide a name in the Project Name text box.
Do not use spaces in the project name. Because the project name will become the name of the library, use something short and descriptive. For illustration purposes, the project name myFP is used throughout the online help.
5
Change the location of the project, if needed. Then click OK. The
Function Plug-in Wizard - Step 1 of 2 window is displayed.
6
Click Help for the Function Plug-in Wizard online help whenever needed.
To access the Function Plug-in Wizard online help from the MicroStrategy online help
1
In the master MicroStrategy online help, search for custom functions, or open the Creating and Modifying Additional Report Objects folder, expand the Metrics folder, and then expand the Using custom
functions
folder.
How MicroStrategy processes functions
67
© 2012 MicroStrategy, Inc.
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
2
Launch the Using custom functions topic. This topic contains a link to the Function Plug-in Wizard online help.
3
Click the Function Plug-in Wizard on-line help link. The Function
Plug-in Wizard online help opens in a new help window.
Additional examples of functions in expressions
Hypothesis Testing example
The reports and report objects in this example can be found in the following folder: MicroStrategy Tutorial\Public Objects\Reports\
MicroStrategy Platform Capabilities\Advanced Analytics\
Statistics and Forecasting\Hypothesis Testing
Which call centers had a statistically significant increase in the average daily sales in recent years?
To answer this question, you must first find the average of daily sales for recent years for each call center. You accomplish this using the Average Daily
Sales metric, defined as:
Average Daily Sales = Avg(Sum(Revenue) {~+, Day+} ) {~+}
This is a simple metric that contains the nested group-value functions Sum and Avg.
68
Additional examples of functions in expressions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
Next, create a report that uses this metric, placing the Call Center attribute on the row axis and the Year attribute on the column axis. A report with this definition is shown below.
In this report it looks like all call centers had a significant increase in the average daily sales in each successive year. However, an average value by itself does not represent the complete picture.
To get more information, you can check the standard deviation of daily sales between each successive year for each call center. You can accomplish this by adding Standard Deviation in Daily Sales to the report. The metric is defined as:
StDev Daily Sales = Stdev(Sum(Revenue) {~+, Day+} ) {~+}
In statistics, standard deviation is a value which shows how widely a set of values differs from the mean.
© 2012 MicroStrategy, Inc.
Additional examples of functions in expressions
69
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
The resulting report provides the average and the standard deviation of daily sales for all years, for each call center.
This report shows that all call centers have greater average daily sales in each successive year. Additionally, the standard deviation of daily sales is higher for each successive year, with a number of exceptions. A couple of these exceptions include Atlanta between 2009 and 2010, as well as San Francisco between 2008 and 2009. The higher standard deviation values mean that there is more volatility in these results. Therefore, the higher average daily sales in each successive year are not necessarily a progressive increase over previous years; they may have been caused by random fluctuations.
Based on this observation, you next need to find out which call centers have a statistically significant difference in their average daily sales between these successive years. You can get the result by testing the hypothesis that the average daily sales are the same, against the hypothesis that the average daily sales are significantly different. This must be tested for each call center.
The hypothesis testing is accomplished by computing the p-value. In statistics, p-value is the probability of making a decision to reject a fact, given that the fact is correct. In the context of this example, it is the probability of making a mistake by concluding that the average daily sales in 2008 is significantly different from 2009, given that actually they are about the same. In general, you want to restrict this type of error so that it is smaller than a certain tolerance level. This tolerance level is usually set to between
2.5% to 10.0%.
70
Additional examples of functions in expressions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
If you assume that the standard deviations of daily sales for all years are the same, then you can use a function called HomoscedasticTTest to compute the p-value. If you assume that the daily standard deviations are different, then you must use the function HeteroscedasticTTest. The following examples consider both of these assumptions and compute the p-value using
HomoscedasticTTest and HeteroscedasticTTest.
This report uses simple metrics based on other metrics, because to calculate the p-value, you need to compute the daily sales for each call center for each day. You also need to group the fact Revenue at the levels of Day and Call
Center for all years. The fact table DAY_CTR_SLS is available at the levels of
Employee, Order, and Day.
Call Center is related to the fact table via Employee.
You need a table with a structure similar to the following:
Call Center
Northwest
Southeast
Day
N
1
1
...
...
N
Daily Sales (last year)
123456
123456
123456
123456
123456
123456
Daily Sales (current year)
123456
123456
123456
123456
123456
123456
You need to create a temporary table with this structure using metrics. These metrics are then used in simple metrics to calculate the p-value.
Follow the steps below to build the necessary metrics for the Hypothesis
Testing report.
1
Build a metric to create the column for [Daily Sales (current year)] in the temporary table. This metric is defined as:
Daily Sales (current year)= Sum(Revenue) {~+, Day+}
<[Current year in sample DB]; @2; ->
The default level notation {~+} is placed on the metric since the default is to group by an attribute on the report. In this example, that report attribute is Call Center. The metric condition Current year in sample DB is also applied to calculate the data for the current year available in the MicroStrategy Tutorial data.
© 2012 MicroStrategy, Inc.
Additional examples of functions in expressions
71
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
2
Build a metric to create the column for [Daily Sales (last year)] in the temporary table. This metric is defined as:
Daily Sales (last year) = Sum(Revenue) {~+, Day+}
<[Last year in sample DB]; @2; -> | [Last Year's] |
This metric uses a metric condition and a transformation.
•
The metric condition Last year in sample DB is applied to calculate the data for the previous year available in the MicroStrategy
Tutorial data.
•
The transformation Last Year's is necessary because attribute
Day is a child of attribute Year. To show Daily Sales in Day 1, 2, …, N of last year together with Daily Sales in Day 1, 2, …, N of the current year, you must use the transformation to supply this data.
3
Build the simple metrics to compute the p-value for each call center by using the metrics above. The simple metrics are defined as follows:
HeteroscedasticTTest([Daily Sales (last year)], [Daily
Sales (current year)]) {~+}
HeteroscedasticTTest([Daily Sales (last year)], [Daily
Sales (current year)]) {~+}
Create a report with the two metrics shown above (for p-value) and the attribute Call Center. The Hypothesis Testing report is shown below.
72
Additional examples of functions in expressions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
The resulting report, Hypothesis Testing, is shown above. All call centers, except for Atlanta, Salt Lake City, Seattle, and Fargo, have a p-value of less that 5%. This indicates that the probability of making an error in concluding that the sales have significantly increased is low for all but these four call centers. Additionally, even Salt Lake City and Fargo are at 20% or lower. This is strong evidence that average daily sales for the majority of the call centers can be attributed to a steady increase, rather than random fluctuations.
The SQL generated for the report Hypothesis Testing is displayed below, along with a summary of the actions taken at the end of the SQL statement:
Pass0 - Execution Duration:0:00:00.06
create table ZZTH0FDXLS4MD000 (
DAY_DATE TIMESTAMP,
CALL_CTR_ID SHORT,
WJXBFS1 DOUBLE)
Pass1 - Execution Duration:0:00:00.34
insert into ZZTH0FDXLS4MD000 select a12.[DAY_DATE] AS DAY_DATE, a11.[CALL_CTR_ID] AS CALL_CTR_ID, a11.[TOT_DOLLAR_SALES] AS WJXBFS1 from [DAY_CTR_SLS] a11,
[LU_DAY] a12 where a11.[DAY_DATE] = a12.[LY_DAY_DATE]
and a12.[YEAR_ID] in (2010)
Pass2 - Execution Duration: 0:00:00.00
create table ZZTU1RY0YSKMD001 (
DAY_DATE TIMESTAMP,
CALL_CTR_ID SHORT,
WJXBFS1 DOUBLE)
Pass3 - Execution Duration: 0:00:00.03
insert into ZZTU1RY0YSKMD001 select a11.[DAY_DATE] AS DAY_DATE, a11.[CALL_CTR_ID] AS CALL_CTR_ID, a11.[TOT_DOLLAR_SALES] AS WJXBFS1 from [DAY_CTR_SLS] a11,
[LU_DAY] a12 where a11.[DAY_DATE] = a12.[DAY_DATE]
and a12.[YEAR_ID] in (2010)
Pass4 - Execution Duration: 0:00:00.07
select pa11.[CALL_CTR_ID] AS CALL_CTR_ID, a13.[CENTER_NAME] AS CENTER_NAME,
© 2012 MicroStrategy, Inc.
Additional examples of functions in expressions
73
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference pa11.[DAY_DATE] AS DAY_DATE, pa11.[WJXBFS1] AS WJXBFS1, pa12.[WJXBFS1] AS WJXBFS2 from [ZZTH0FDXLS4MD000] pa11,
[ZZTU1RY0YSKMD001] pa12,
[LU_CALL_CTR] a13 where pa11.[CALL_CTR_ID] = pa12.[CALL_CTR_ID] and pa11.[DAY_DATE] = pa12.[DAY_DATE] and pa11.[CALL_CTR_ID] = a13.[CALL_CTR_ID]
Pass5 - Execution Duration: 0:00:00.00
[Analytical SQL calculated by the Analytical Engine: select CALL_CTR_ID,
CENTER_NAME,
HomoscedasticTTest(WJXBFS1, WJXBFS2),
HeteroscedasticTTest(WJXBFS1, WJXBFS2) from [previous pass]
]
Pass6 - Execution Duration: 0:00:00.00
[Populate Report Data]
Pass7 - Execution Duration: 0:00:00.06
drop table ZZTH0FDXLS4MD000
Pass8 - Execution Duration: 0:00:00.01
drop table ZZTU1RY0YSKMD001
•
Pass0 and Pass1 are issued by Intelligence Server to compute the metric
Daily Sales (last year). The Intelligence Server prepares the temporary table with Call Center and Day as its key. Then, it retrieves last year’s sales using the transformation Last Year’s.
•
Pass2 and Pass3 are issued to compute the metric Daily Sales (current year). Attributes Call Center and Day are used as keys to the temporary table. This pass is similar to Pass0 and Pass1 with the key difference being that the metric does not have a transformation.
•
In Pass4 and Pass5, the Intelligence Server computes the p-value for each call center, using the HeteroscedasticTTest and the HomoscedasticTTest functions.
•
The remaining passes perform final report preparation and drop the temporary tables.
74
Additional examples of functions in expressions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
Confidence level example
The reports and report components in this example can be found in the following folder:
MicroStrategy Tutorial\Public Objects\Reports\
MicroStrategy Platform Capabilities\Advanced Analytics\
Statistics and Forecasting\Confidence Level
Confidence level is used to determine valuable customers in two slightly different ways:
•
Who are my valuable customers? (Example 1), page 75
valuable customers as those whose average spending is above an upper bound of sales orders.
•
Who are my valuable customers? (Example 2), page 81
: Determines valuable customers as those whose average spending is above an upper bound of sales orders. Additionally, valuable customers are compared for each Customer Region, rather than comparing customers in all regions.
Who are my valuable customers? (Example 1)
The basic goal is to define a cut-off value that represents the minimum requirement to be classified as a valuable customer. To identify the valuable customers in your customer base, you must determine the parameters that help differentiate those customers from the others. In this example, valuable customers are those whose average spending is above an upper bound of sales orders.
The ORDER_FACT table contains all orders received. Assume that the sales order amount is normally distributed with a certain mean and standard deviation. Based on the assumption of normal distribution and a confidence level of 99%, you can define valuable customers as those who have a spending average above an upper bound of sales orders.
To determine the valuable customers based on this criteria, you need to know several values. Use the following metrics to obtain these values.
1
You must know the average sales order from all orders in the
ORDER_FACT table. This is the arithmetic mean of the normal distribution. You can get this value using the Avg function. The metric to compute the average of sales orders from the ORDER_FACT table can be defined as:
© 2012 MicroStrategy, Inc.
Additional examples of functions in expressions
75
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
M01 = Avg(Revenue) {![Call Center]+, !Year+,
!Employee+, !Order+, !Day+}
Since Day, Employee, and Order are the highest attributes that are parents of the keys in the ORDER_FACT table, include them as the level of aggregation to make sure that the ORDER_FACT table is used. Also, the average must be calculated over all sales order amounts, so you must set the group-by on the level attributes to none. This ensures that the metric does not group by any of these attributes.
2
You must know the standard deviation of sales orders from all orders.
This number is the standard deviation of the normal distribution. You can get this value using the StDevP function (see
StDevP (standard deviation of a population), page 117
StDevP is the standard deviation of a population, while StDev is the standard deviation of a sample. Therefore, the StDevP function is used when there is enough data to fully represent a scenario.
The metric to compute the population standard deviation of sales orders from the ORDER_FACT table is defined as follows:
M02 = StdevP(Revenue) {![Call Center]+, !Year+,
!Employee+, !Order+, !Day+}
3
You must know the number of rows in the ORDER_FACT table. You need this value to calculate the cut-off value. You can retrieve this value by using the Count function, in particular, Count from the ORDER_FACT table. The metric to count the data in the ORDER_FACT table is defined as follows:
M03 = Count(Revenue) {![Call Center]+, !Year+,
!Employee+, !Order+, !Day+}
4
Under the assumption of normal distribution with the parameters given above, you must determine the cut-off value that represents the top 5% of sales order amounts. To do this, you can use the Confidence plug-in function. The metric to compute the cut-off number is defined as follows, using some of the metrics defined above:
M04 = Confidence(0.01, [M02], [M03])
The number 0.01 comes from a normal distribution with 99% confidence level.
76
Additional examples of functions in expressions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
5
The metric that calculates the upper bound uses some of the metrics defined above, and is defined as follows:
M05 = ([M01] + [M04])
6
You must calculate the average sales for each customer to get a list of valuable customers based on the criteria. The metric is defined as follows:
Average Sales = Avg(Revenue) {~+}
You do not need to include the level of aggregation for Average Sales since the default {~+} notation is replaced by the attribute Customer.
7
You must also apply a metric qualification in a filter to restrict the rows returned to those that meet the definition of valuable customers. The filter is defined as follows:
F01 = Set of Customers where (Average Sales Greater than [M05]
To generate a report listing valuable customers, create a report with the attribute Customer on the row axis and the attribute Customer Region on the page-by axis. Apply filter F01 to the report to produce a list of valuable
© 2012 MicroStrategy, Inc.
Additional examples of functions in expressions
77
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference customers for each attribute element in Customer Region. The Valuable
Customers 01 report is shown below:
The SQL generated for the report Valuable Customers 01 is as follows:
Pass0 - Execution Duration: 0:00:00.07
create table ZZTLZV82TJ0MD000 (
CUSTOMER_ID LONG,
WJXBFS1 DOUBLE)
Pass1 - Execution Duration: 0:00:00.20
insert into ZZTLZV82TJ0MD000 select a11.[CUSTOMER_ID] AS CUSTOMER_ID, avg(a11.[TOT_DOLLAR_SALES]) AS WJXBFS1 from [CUSTOMER_SLS] a11 group by a11.[CUSTOMER_ID]
Pass2 - Execution Duration: 0:00:00.04
select a11.[CUSTOMER_ID] AS CUSTOMER_ID, a11.[ORDER_ID] AS ORDER_ID, a11.[ITEM_ID] AS ITEM_ID, a11.[EMP_ID] AS EMP_ID, a11.[ORDER_DATE] AS DAY_DATE,
78
Additional examples of functions in expressions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1 a11.[CUSTOMER_ID] AS CUSTOMER_ID0,
(a11.[QTY_SOLD] * (a11.[UNIT_PRICE] - a11.[DISCOUNT]))
AS WJXBFS1 from [ORDER_DETAIL] a11
Pass3 - Execution Duration: 0:00:00.10
create table ZZTW4A12VECMD001 (
CUSTOMER_ID LONG,
WJXBFS1 DOUBLE)
Pass4 - Execution Duration: 0:00:00.00
[Analytical SQL calculated by the Analytical Engine: select CUSTOMER_ID0,
(ISNULL(avg(WJXBFS1), 0) + Confidence(0.01,
StdevP(WJXBFS1), count(WJXBFS1))) from [previous pass]
]
Pass5 - Execution Duration: 0:00:00.00
insert into ZZTW4A12VECMD001 values (1, 33.4351602545)
Pass6 - Execution Duration: 0:00:00.00
create table ZZTPDKUSLWSMQ002 (
CUSTOMER_ID LONG)
Pass7 - Execution Duration: 0:00:00.10
insert into ZZTPDKUSLWSMQ002 select pa11.[CUSTOMER_ID] AS CUSTOMER_ID from [ZZTLZV82TJ0MD000] pa11,
[ZZTW4A12VECMD001] pa12 where pa11.[CUSTOMER_ID] = pa12.[CUSTOMER_ID]
and (pa11.[WJXBFS1] > pa12.[WJXBFS1])
Pass8 - Execution Duration: 0:00:01.53
select a11.[CUSTOMER_ID] AS CUSTOMER_ID, max(a13.[CUST_LAST_NAME]) AS CUST_LAST_NAME, max(a13.[CUST_FIRST_NAME]) AS CUST_FIRST_NAME, a15.[CUST_REGION_ID] AS CUST_REGION_ID, max(a16.[CUST_REGION_NAME]) AS CUST_REGION_NAME0, avg(a11.[TOT_DOLLAR_SALES]) AS WJXBFS1 from [CUSTOMER_SLS] a11,
[ZZTPDKUSLWSMQ002] pa12,
[LU_CUSTOMER] a13,
[LU_CUST_CITY] a14,
[LU_CUST_STATE] a15,
[LU_CUST_REGION] a16
© 2012 MicroStrategy, Inc.
Additional examples of functions in expressions
79
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference where a11.[CUSTOMER_ID] = pa12.[CUSTOMER_ID] and a11.[CUSTOMER_ID] = a13.[CUSTOMER_ID] and a13.[CUST_CITY_ID] = a14.[CUST_CITY_ID] and a14.[CUST_STATE_ID] = a15.[CUST_STATE_ID] and a15.[CUST_REGION_ID] = a16.[CUST_REGION_ID] group by a11.[CUSTOMER_ID], a15.[CUST_REGION_ID]
Pass9 - Execution Duration: 0:00:00.00
[Populate Report Data]
Pass10 - Execution Duration: 0:00:00.06
drop table ZZTLZV82TJ0MD000
Pass11 - Execution Duration: 0:00:00.00
drop table ZZTW4A12VECMD001
Pass12 - Execution Duration: 0:00:00.00
drop table ZZTPDKUSLWSMQ002
•
Pass0 and Pass1 compute the average sales per customer (Average Sales metric) and put the results in a temporary table.
•
Pass2 retrieves ORDER_DETAIL data, puts the data into memory, and uses the data to compute M01, M02, and M03.
•
Pass3 creates a temporary table used to store the results of the calculations.
•
Pass4 calculates M02 using the Intelligence Server because the group-value function StDevP is not supported by the Access database.
The values of M01, M02, and M03 are used to compute M05.
•
Pass5 inserts the results of the calculations into the temporary table.
•
Pass6 and Pass7 use the earlier two temporary tables to qualify on valuable customers based on the definition.
•
Pass8 displays the report with attributes Customer and Customer Region.
•
The remaining passes perform additional report preparation and drop the temporary tables.
80
Additional examples of functions in expressions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
Who are my valuable customers? (Example 2)
This example generates a list of valuable customers based on a different definition from the previous example.
Assume a normal distribution of sales orders is still valid, but the cut-off value is for each Customer Region. This means you must compare the average spending of each customer against the average spending of the
Customer Region to which the customer belongs. To allow for more variation, take the average value from the current year data, but use sample standard deviations for all available years. Use a confidence level of 95%.
Valuable customers are defined as those customers who have total spending above the cut-off value. The cut-off value is calculated using the filters and metrics defined below:
1
The filter used to limit the calculation of average sales orders to only the data for the current year is defined as follows:
Current year in sample DB = Year In list (2010)
2
The metric used to calculate the average sales order is defined as follows:
M07 = Avg(Revenue) {[Customer Region]+, !Year+,
!Employee+, !Order+, !Day+} <[Current year in sample
DB]; @2; ->
3
The metric used to calculate the standard deviation of sales orders is defined as follows:
M08 = Stdev(Revenue) {[Customer Region]+, ![Call
Center]+, !Year+, !Employee+, !Order+, !Day+}
Notice that the function Stdev (standard deviation of a sample) is used in this metric because the amount of data is limited to each Customer
Region. This means the data can be considered as more of a sample than a full population.
4
The metric used to determine the cut-off value is defined as follows, using the preceding metrics:
M09 = ([M07] + (1.96 * [M08]))
The number 1.96 comes from a normal distribution with 95% confidence level. In practice, this number is often rounded to 2 instead of 1.96.
Additional examples of functions in expressions
81
© 2012 MicroStrategy, Inc.
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
5
The metric used to determine each customer’s spending so that it can be compared to the cut-off value is defined as follows:
M10 = Sum(Revenue){~+}
6
The metric qualification (filter) needed to restrict the report to a list of valuable customers based on Definition 2 is defined as follows:
F03 = Set of Customer where (M10 Greater than [M09])
7
To view the last order sales from all valuable customers, use the metric defined as follows:
Last Order Sales = Sum(Revenue) {~+, >|Day+}
You must compute order sales for each customer at the Day level from the
ORDER_FACT table, but must take it from the last Day on that fact table.
The {~+} is replaced by any attribute on the report. In this example, it is the Customer attribute.
Build a report putting the attribute Customer on the row axis, the attribute
Customer Region on the page-by axis, and the Last Order Sales metric on the
82
Additional examples of functions in expressions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1 column axis, then applying the filter F03. The Valuable Customers 02 report is shown below.
The SQL generated by the Valuable Customers 02 report is as follows:
Pass0 - Execution Duration: 0:00:00.00
create table ZZT3WSP7T8BMD000 (
CUSTOMER_ID LONG,
WJXBFS1 DOUBLE)
Pass1 - Execution Duration: 0:00:00.06
insert into ZZT3WSP7T8BMD000 select a11.[CUSTOMER_ID] AS CUSTOMER_ID, sum(a11.[TOT_DOLLAR_SALES]) AS WJXBFS1 from [CUSTOMER_SLS] a11 group by a11.[CUSTOMER_ID]
Pass2 - Execution Duration: 0:00:00.00
create table ZZT36UF785VMD001 (
CUST_REGION_ID SHORT,
© 2012 MicroStrategy, Inc.
Additional examples of functions in expressions
83
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
WJXBFS1 DOUBLE)
Pass3 - Execution Duration: 0:00:02.18
insert into ZZT36UF785VMD001 select a14.[CUST_REGION_ID] AS CUST_REGION_ID, avg((a11.[QTY_SOLD] * (a11.[UNIT_PRICE] a11.[DISCOUNT]))) AS WJXBFS1 from [ORDER_DETAIL] a11,
[LU_CUSTOMER] a12,
[LU_CUST_CITY] a13,
[LU_CUST_STATE] a14,
[LU_DAY] a15 where a11.[CUSTOMER_ID] = a12.[CUSTOMER_ID] and a12.[CUST_CITY_ID] = a13.[CUST_CITY_ID] and a13.[CUST_STATE_ID] = a14.[CUST_STATE_ID] and a11.[ORDER_DATE] = a15.[DAY_DATE]
and a15.[YEAR_ID] in (2010) group by a14.[CUST_REGION_ID]
Pass4 - Execution Duration: 0:00:00.03
select a11.[CUSTOMER_ID] AS CUSTOMER_ID, a11.[ORDER_ID] AS ORDER_ID, a11.[ITEM_ID] AS ITEM_ID, a11.[EMP_ID] AS EMP_ID, a11.[ORDER_DATE] AS DAY_DATE, a14.[CUST_REGION_ID] AS CUST_REGION_ID,
(a11.[QTY_SOLD] * (a11.[UNIT_PRICE] - a11.[DISCOUNT]))
AS WJXBFS1 from [ORDER_DETAIL] a11,
[LU_CUSTOMER] a12,
[LU_CUST_CITY] a13,
[LU_CUST_STATE] a14 where a11.[CUSTOMER_ID] = a12.[CUSTOMER_ID] and a12.[CUST_CITY_ID] = a13.[CUST_CITY_ID] and a13.[CUST_STATE_ID] = a14.[CUST_STATE_ID]
Pass5 - Execution Duration: 0:00:00.00
create table ZZTS6MZ3N2BMD002 (
CUST_REGION_ID SHORT,
WJXBFS1 DOUBLE)
Pass6 - Execution Duration: 0:00:00.00
[Analytical SQL calculated by the Analytical Engine: select CUST_REGION_ID,
ISNULL((1.96 * Stdev(WJXBFS1)), 0) from [previous pass]
84
Additional examples of functions in expressions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
]
Pass7 - Execution Duration: 0:00:00.00
insert into ZZTS6MZ3N2BMD002 values (1, 127.4088118401)
Pass8 - Execution Duration: 0:00:00.00
create table ZZTSMWZF9SRMQ003 (
CUSTOMER_ID LONG)
Pass9 - Execution Duration: 0:00:00.36
insert into ZZTSMWZF9SRMQ003 select distinct pa11.[CUSTOMER_ID] AS CUSTOMER_ID from [ZZT3WSP7T8BMD000] pa11,
[LU_CUSTOMER] a12,
[LU_CUST_CITY] a13,
[LU_CUST_STATE] a14,
[ZZT36UF785VMD001] pa15,
[ZZTS6MZ3N2BMD002] pa16 where pa11.[CUSTOMER_ID] = a12.[CUSTOMER_ID] and a12.[CUST_CITY_ID] = a13.[CUST_CITY_ID] and a13.[CUST_STATE_ID] = a14.[CUST_STATE_ID] and a14.[CUST_REGION_ID] = pa15.[CUST_REGION_ID] and pa15.[CUST_REGION_ID] = pa16.[CUST_REGION_ID]
and (pa11.[WJXBFS1] > (IIF(ISNULL(pa15.[WJXBFS1]), 0, pa15.[WJXBFS1]) + IIF(ISNULL(pa16.[WJXBFS1]), 0, pa16.[WJXBFS1])))
Pass10 - Execution Duration: 0:00:00.00
create table ZZTRX7EEWHNNB004 (
DAY_DATE TIMESTAMP,
CUSTOMER_ID LONG,
WJXBFS1 DOUBLE)
Pass11 - Execution Duration: 0:00:07.89
insert into ZZTRX7EEWHNNB004 select a11.[ORDER_DATE] AS DAY_DATE, a11.[CUSTOMER_ID] AS CUSTOMER_ID, sum((a11.[QTY_SOLD] * (a11.[UNIT_PRICE] a11.[DISCOUNT]))) AS WJXBFS1 from [ORDER_DETAIL] a11,
[ZZTSMWZF9SRMQ003] pa12 where a11.[CUSTOMER_ID] = pa12.[CUSTOMER_ID] group by a11.[ORDER_DATE], a11.[CUSTOMER_ID]
Pass12 - Execution Duration: 0:00:00.00
© 2012 MicroStrategy, Inc.
Additional examples of functions in expressions
85
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference create table ZZTQFB0EMCJMB005 (
CUSTOMER_ID LONG,
WJXBFS1 TIMESTAMP)
Pass13 - Execution Duration: 0:00:00.59
insert into ZZTQFB0EMCJMB005 select pc11.[CUSTOMER_ID] AS CUSTOMER_ID, max(pc11.[DAY_DATE]) AS WJXBFS1 from [ZZTRX7EEWHNNB004]pc11 group bypc11.[CUSTOMER_ID]
Pass14 - Execution Duration:0:00:00.78
selectdistinct pa11.[CUSTOMER_ID] AS CUSTOMER_ID, a13.[CUST_LAST_NAME] AS CUST_LAST_NAME, a13.[CUST_FIRST_NAME] AS CUST_FIRST_NAME, a15.[CUST_REGION_ID] AS CUST_REGION_ID, a16.[CUST_REGION_NAME] AS CUST_REGION_NAME0, pa11.[WJXBFS1] AS WJXBFS1 from[ZZTRX7EEWHNNB004]pa11,
[ZZTQFB0EMCJMB005]pa12,
[LU_CUSTOMER]a13,
[LU_CUST_CITY]a14,
[LU_CUST_STATE]a15,
[LU_CUST_REGION]a16 wherepa11.[CUSTOMER_ID] = pa12.[CUSTOMER_ID] and pa11.[DAY_DATE] = pa12.[WJXBFS1] and pa11.[CUSTOMER_ID] = a13.[CUSTOMER_ID] and a13.[CUST_CITY_ID] = a14.[CUST_CITY_ID] and a14.[CUST_STATE_ID] = a15.[CUST_STATE_ID] and a15.[CUST_REGION_ID] = a16.[CUST_REGION_ID]
Pass15 - Execution Duration:0:00:00.00
[Populate Report Data]
Pass16 - Execution Duration:0:00:00.00
drop table ZZT3WSP7T8BMD000
Pass17 - Execution Duration:0:00:00.00
drop table ZZT36UF785VMD001
Pass18 - Execution Duration:0:00:00.01
drop table ZZTS6MZ3N2BMD002
Pass19 - Execution Duration:0:00:00.00
drop table ZZTSMWZF9SRMQ003
86
Additional examples of functions in expressions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
Pass20 - Execution Duration:0:00:00.00
drop table ZZTRX7EEWHNNB004
Pass21 - Execution Duration:0:00:00.00
drop table ZZTQFB0EMCJMB005
•
Pass0 and Pass1 compute metric M10.
•
Pass2 and Pass3 compute metric M07.
•
Pass4, Pass5, Pass6, and Pass7 compute (1.96 * M08). The group-value function for M08, StDev, is not supported by the database (Microsoft
Access) so it is calculated by Intelligence Server.
•
Pass8 and Pass9 obtain the list of valuable customers, evaluating the filter condition F03.
•
Pass10, Pass11, Pass12, and Pass13 compute the Last Order Sales metric.
•
Pass 14 displays the results for the report.
•
All other passes drop the temporary tables.
Statistical descriptors - Simple example
The report and report components used in this example can be found in the
MicroStrategy Tutorial project in the following folder:
MicroStrategy Tutorial\Public Objects\Reports\
MicroStrategy Platform Capabilities\Advanced Analytics\
Statistics and Forecasting\Statistical Descriptors
The Component Objects - Advanced folder contains additional statistical descriptor examples.
How do I learn more about my customers?
You can get more information about the customers in each region by performing statistical calculations on their spending. This example uses analysis to answer the following questions:
•
How many customers exist in each customer region?
•
What is the average spending of customers in each customer region?
•
What is the median spending of customers in each customer region?
Additional examples of functions in expressions
87
© 2012 MicroStrategy, Inc.
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
•
What is the standard deviation of customer spending in each customer region?
•
How much is the 25th and 75th percentile of customer spending in each customer region?
These are statistical descriptors about customers in each customer region.
This type of data can help you understand how customers spend their money.
To answer the questions above, you must create a set of simple metrics based on other metrics. These metrics are defined using nested group-value functions.
1
This metric determines the number of customers in each region:
Count of Customers = Sum(Count(1) {~+, Customer+} )
{~+}
2
This metric determines the average spending of customers in each region: a.Mean Revenue Per Customer = Avg(Sum(Revenue) {~+,
Customer+} ) {~+}
3
This metric determines the median spending of customers in each region: b.Median Revenue Per Customer = Median(Sum(Revenue)
{~+, Customer+} ) {~+}
4
This metric determines the standard deviation of customer spending in each region: e.StDev of Revenue Per Customer = Stdev(Sum(Revenue)
{~+, Customer+} ) {~+}
5
This metric determines the threshold for the 25th percentile:
25th Percentile of Revenue Per Customer =
Percentile(Sum(Revenue) {~+, Customer+} , 0.25) {~+}
6
This metric determines the threshold for the 75th percentile:
75th Percentile of Revenue Per Customer =
Percentile(Sum(Revenue) {~+, Customer+} , 0.75) {~+}
88
Additional examples of functions in expressions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
Create a report and place all of the metrics described above on the row axis and place the attribute Customer Region on the column axis. Execute the
Statistical Descriptors - Simple report, which is shown below:
This report provides information on the behavior of customer spending in each customer region. For example, the Northwest customer region has the least number of customers, but most customers in that region spend more than any other region, as seen in the larger mean and median revenues per customer. This can highlight that it is worthwhile to gain a larger customer base in this region. However, the somewhat lower value for the standard deviation of revenue per customer in the Northwest region also indicates that this result might be due to the smaller sample size and a few customers that spend abnormally large amounts. This standard deviation value helps to show that while a campaign to increase the customer base in the region is still an attractive idea, the results should be monitored to determine if revenues continue to be higher per customer.
The SQL generated for the Statistical Descriptors - Simple report is as follows:
Pass0 - Execution Duration: 0:00:00.00
create table ZZT42W71C95MD000 (
CUSTOMER_ID LONG,
WJXBFS1 LONG,
WJXBFS2 DOUBLE)
Pass1 - Execution Duration: 0:00:00.06
insert into ZZT42W71C95MD000 select a11.[CUSTOMER_ID] AS CUSTOMER_ID, count(1.0) AS WJXBFS1, sum(a11.[TOT_DOLLAR_SALES]) AS WJXBFS2 from [CUSTOMER_SLS] a11 group by a11.[CUSTOMER_ID]
Pass2 - Execution Duration: 0:00:00.09
select distinct pa11.[CUSTOMER_ID] AS CUSTOMER_ID, a14.[CUST_REGION_ID] AS CUST_REGION_ID, a15.[CUST_REGION_NAME] AS CUST_REGION_NAME0, pa11.[WJXBFS1] AS WJXBFS1,
© 2012 MicroStrategy, Inc.
Additional examples of functions in expressions
89
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference pa11.[WJXBFS2] AS WJXBFS2 from [ZZT42W71C95MD000] pa11,
[LU_CUSTOMER] a12,
[LU_CUST_CITY] a13,
[LU_CUST_STATE] a14,
[LU_CUST_REGION] a15 where pa11.[CUSTOMER_ID] = a12.[CUSTOMER_ID] and a12.[CUST_CITY_ID] = a13.[CUST_CITY_ID] and a13.[CUST_STATE_ID] = a14.[CUST_STATE_ID] and a14.[CUST_REGION_ID] = a15.[CUST_REGION_ID]
Pass3 - Execution Duration: 0:00:00.00
[Analytical SQL calculated by the Analytical Engine: select CUST_REGION_ID,
CUST_REGION_NAME0, sum(WJXBFS1), avg(WJXBFS2),
Median(WJXBFS2),
Stdev(WJXBFS2),
Percentile(WJXBFS2, 0.25),
Percentile(WJXBFS2, 0.75) from [previous pass]
]
Pass4 - Execution Duration: 0:00:00.00
[Populate Report Data]
Pass5 - Execution Duration: 0:00:00.00
drop table ZZT42W71C95MD000
•
The first two passes of SQL (Pass0 and Pass1) prepare and calculate the values used in other metrics.
The Intelligence Server optimizes the process by pulling only a single column of revenue data even though it is used in several other metrics.
•
In Pass2 and Pass3 the Intelligence Server retrieves the results from
Pass1 to compute the other metrics. In Pass3 the Intelligence Server acts as an in-memory database, using the values from Pass2 to calculate the following group-value functions: Sum, Avg, Median, Stdev, and
Percentile.
•
The remaining passes prepare the report and drop the temporary tables.
90
Additional examples of functions in expressions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
Forecasting example
The report and report components in this example can be found in the
MicroStrategy Tutorial project in the following folder:
MicroStrategy Tutorial\Public Objects\Reports\
MicroStrategy Platform Capabilities\Advanced Analytics\
Statistics and Forecasting\Forecasting
How to forecast future sales based on existing sales data?
The MicroStrategy Tutorial project has sales data for multiple years. Using this data, you can forecast potential sales for the upcoming years.
To plot a sales line for the expected future sales data, apply linear extrapolation techniques to the historical data. Linear extrapolation involves the assumption that the trend of past data will continue in a linear fashion.
The slope and Y-intercept values are calculated based on historical data, and the same slope and Y-intercept are applied to extend the data into the future.
This is just one type of forecasting analysis that can be done in
MicroStrategy. There are additional MicroStrategy functions that provide other variations on calculating a forecast of values. For information on these functions, how they forecast values, and forecasting examples using these functions, see:
•
ForecastV (forecast, vector input), page 358
•
GrowthV (growth, vector input), page 363
•
TrendV (trend, vector input), page 389
To perform the analysis, build a set of metrics that calculate each of the components in the analysis, then use those metrics together to create the final Forecasting metric.
1
The metric that calculates sales revenue at the Year level is defined as follows:
Revenue {Year} = Sum(Revenue) {~+, Year+}
2
The metric that expresses the Year elements as a series of integers, to simplify the analysis, is defined as follows:
YearNumber = RunningSum<SortBy= (Year@ID) >(Sum(1)
{~+, Year } )
© 2012 MicroStrategy, Inc.
Additional examples of functions in expressions
91
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
3
The metric that calculates the slope of the line produced by the Revenue
{Year} metric is defined as follows:
SlopeMetric = Slope([Revenue {Year}], YearNumber) {~+,
!Year+}
4
The metric that calculates the Y-intercept of the line produced by the
Revenue {Year} metric is defined as follows:
InterceptMetric = Intercept([Revenue {Year}],
YearNumber) {~+, !Year+}
5
The final metric combines the three preceding metrics into a forecast value. This formula follows the standard formula for a line: y = mx + b.
The metric is defined as follows:
Forecast = ((SlopeMetric * YearNumber) +
InterceptMetric)
Place the Forecast metric on a report with Year. A sales forecast is generated for all available years. The Forecast (Graph) report displays as follows:
The sales for 2008, 2009, and 2010 are actual recorded values, and the sales for 2011 are a linear extrapolation of the existing data into the future.
Another report in the Forecasting folder, Forecast (Grid) places the
Forecast metric alongside the Revenue metric for comparison.
92
Additional examples of functions in expressions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
However, it requires the use of outer joins to work properly. The
MicroStrategy Tutorial includes Microsoft Access as its default database; in order for the Forecast (Grid) report to work, the Tutorial warehouse must be moved into a database platform that fully supports outer joins.
The following SQL is generated for the Forecast (Graph) report:
Pass0 - Execution Duration: 0:00:00.20
create table ZZT16JMSID1MD000 (
YEAR_ID SHORT,
CATEGORY_ID SHORT,
WJXBFS1 DOUBLE)
Pass1 - Execution Duration: 0:00:00.10
insert into ZZT16JMSID1MD000 select a11.[YEAR_ID] AS YEAR_ID, a11.[CATEGORY_ID] AS CATEGORY_ID, a11.[TOT_DOLLAR_SALES] AS WJXBFS1 from [YR_CATEGORY_SLS] a11
Pass2 - Execution Duration: 0:00:00.23
select a12.[YEAR_ID] AS YEAR_ID, a11.[CATEGORY_ID] AS CATEGORY_ID,
1.0 AS WJXBFS1 from [LU_CATEGORY] a11,
[LU_YEAR] a12
Pass3 - Execution Duration: 0:00:00.00
create table ZZT3M2QSNWDMD001 (
YEAR_ID SHORT,
CATEGORY_ID SHORT,
WJXBFS1 DOUBLE)
Pass4 - Execution Duration: 0:00:00.00
[Analytical SQL calculated by the Analytical Engine: select YEAR_ID,
CATEGORY_ID,
RunningSum<SortBy= ([YEAR_ID])>(WJXBFS1) from [previous pass]
]
Pass5 - Execution Duration: 0:00:00.00
insert into ZZT3M2QSNWDMD001 values (2008, 1, 1)
Pass6 - Execution Duration: 0:00:00.00
© 2012 MicroStrategy, Inc.
Additional examples of functions in expressions
93
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference create table ZZTDMBESMXPOJ002 (
YEAR_ID SHORT,
CATEGORY_ID SHORT)
Pass7 - Execution Duration: 0:00:00.00
insert into ZZTDMBESMXPOJ002 select pa11.[YEAR_ID] AS YEAR_ID, pa11.[CATEGORY_ID] AS CATEGORY_ID from [ZZT16JMSID1MD000] pa11
Pass8 - Execution Duration: 0:00:00.00
insert into ZZTDMBESMXPOJ002 select pa11.[YEAR_ID] AS YEAR_ID, pa11.[CATEGORY_ID] AS CATEGORY_ID from [ZZT3M2QSNWDMD001] pa11
Pass9 - Execution Duration: 0:00:00.00
create table ZZT9MCAB4STOD003 (
YEAR_ID SHORT,
CATEGORY_ID SHORT)
Pass10 - Execution Duration: 0:00:00.00
insert into ZZT9MCAB4STOD003 select distinct pa11.[YEAR_ID] AS YEAR_ID, pa11.[CATEGORY_ID] AS CATEGORY_ID from [ZZTDMBESMXPOJ002] pa11
Pass11 - Execution Duration: 0:00:00.00
select pa11.[YEAR_ID] AS YEAR_ID, pa11.[CATEGORY_ID] AS CATEGORY_ID, pa12.[WJXBFS1] AS WJXBFS1, pa13.[WJXBFS1] AS WJXBFS2 from [ZZT9MCAB4STOD003] pa11,
[ZZT16JMSID1MD000] pa12,
[ZZT3M2QSNWDMD001] pa13 where pa11.[CATEGORY_ID] = pa12.[CATEGORY_ID] and pa11.[YEAR_ID] = pa12.[YEAR_ID] and pa11.[CATEGORY_ID] = pa13.[CATEGORY_ID] and pa11.[YEAR_ID] = pa13.[YEAR_ID]
Pass12 - Execution Duration: 0:00:00.00
create table ZZTMYCAAR65MD004 (
CATEGORY_ID SHORT,
WJXBFS1 DOUBLE,
WJXBFS2 DOUBLE)
94
Additional examples of functions in expressions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Understanding Functions in MicroStrategy 1
Pass13 - Execution Duration: 0:00:00.00
[Analytical SQL calculated by the Analytical Engine: select CATEGORY_ID,
Slope(WJXBFS1, WJXBFS2),
Intercept(WJXBFS1, WJXBFS2) from [previous pass]
]
Pass14 - Execution Duration: 0:00:00.00
insert into ZZTMYCAAR65MD004 values (1,
58938.0812500116, 585341.077083335)
Pass15 - Execution Duration: 0:00:00.04
select pa11.[CATEGORY_ID] AS CATEGORY_ID, a13.[CATEGORY_DESC] AS CATEGORY_DESC0, pa11.[YEAR_ID] AS YEAR_ID,
(IIF(ISNULL((pa12.[WJXBFS1] * pa11.[WJXBFS1])), 0,
(pa12.[WJXBFS1] * pa11.[WJXBFS1])) +
IIF(ISNULL(pa12.[WJXBFS2]), 0, pa12.[WJXBFS2])) AS
WJXBFS1 from [ZZT3M2QSNWDMD001] pa11,
[ZZTMYCAAR65MD004] pa12,
[LU_CATEGORY] a13 where pa11.[CATEGORY_ID] = pa12.[CATEGORY_ID] and pa11.[CATEGORY_ID] = a13.[CATEGORY_ID]
Pass16 - Execution Duration: 0:00:00.00
[Populate Report Data]
Pass17 - Execution Duration: 0:00:00.00
drop table ZZT16JMSID1MD000
Pass18 - Execution Duration: 0:00:00.00
drop table ZZT3M2QSNWDMD001
Pass19 - Execution Duration: 0:00:00.00
drop table ZZTDMBESMXPOJ002
Pass20 - Execution Duration: 0:00:00.00
drop table ZZT9MCAB4STOD003
Pass21 - Execution Duration: 0:00:00.00
drop table ZZTMYCAAR65MD004
•
Pass0 and Pass1 calculate the Revenue {Year} metric.
© 2012 MicroStrategy, Inc.
Additional examples of functions in expressions
95
1
Understanding Functions in MicroStrategy MicroStrategy Functions Reference
•
Pass2 calculates the inner portion of the YearNumber metric, assigning the integer 1 to each year available in the LU_YEAR lookup table. Note that this metric was defined by adding Year dimensionality with filtering set to None. This forces the metric into its own pass of SQL, to ensure that all years in the lookup table are numbered, not just the years with data in the fact table.
•
Passes 3 to 14 calculate the metrics YearNumber, SlopeMetric, and
InterceptMetric. The Intelligence Server performs the calculations based on the data in the temporary table from Pass0, Pass1, and Pass2. Values are calculated and inserted back into the temporary tables.
•
In Pass15, the Forecast metric is calculated based on the information from all of the previous calculations. The mx+b calculation is performed as part of the SQL statement.
•
The remaining passes prepare the report and drop the temporary tables.
96
Additional examples of functions in expressions © 2012 MicroStrategy, Inc.
2.
S
TANDARD
F
UNCTIONS
2
Introduction
The standard functions in this chapter range from simple operations like Sum and Product to internal functions that allow you to define your own metrics, facts, and filters. Taken as a set, they provide a powerful toolset for performing common mathematical calculations, grouping data, examining correlation, validating data, and formatting report information for display.
The following categories of functions are covered:
•
•
Date and time functions, page 124
•
•
•
•
Rank and NTile functions, page 211
•
© 2012 MicroStrategy, Inc.
97
2
Standard Functions MicroStrategy Functions Reference
Each section in this chapter describes a function category and presents a list of functions within each category. Each section also presents the data necessary to understand and implement each individual function. The information provided for each function includes
•
An explanation of the data returned by the function
•
The syntax of the function including function name, available parameters, the parameter setting defaults, and the types of data that can be used with the function
•
The mathematical expression illustrating exactly how the calculation is defined in MicroStrategy (if applicable)
•
Usage notes describing any error conditions, invalid data types, or key information to know before using the function (if applicable)
•
An example of the function in use; this may be either a report example or a simple text description of the data returned based on the specified input
Note the following:
•
The report examples in this section use objects and data found in the MicroStrategy Tutorial.
•
Appendix A, MicroStrategy and Database Support for
, for a list of the databases and the functions they
support.
Basic functions
These are basic mathematical functions like Avg, Greatest, Least, Max, Min, and so on, and are among the most commonly used functions.
Add
Returns the sum of two or more values. The Add function differs from the
Sum function (see
), which returns the sum of values in a
single value list. Add can take multiple metrics as inputs and add the values of the metrics.
You can also construct these types of metrics using the plus operator (see
) instead of the Add function.
98
Basic functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Syntax
Add(Argument1, Argument2,..., ArgumentN)
Where
The arguments must be metrics or constants.
Example
You can use the Add function to return the sum of related metrics. In the report shown below, the Total Paid Compensation metric uses the formula
Add([Paid Bonus],[Paid Salary]) to return the total compensation paid to each employee. This report was created in the MicroStrategy Human
Resources Analysis Module.
Average
Average performs a sum of a set of values and divides this total by the number of values in the set. This returns the average (also known as arithmetic mean) for the set of values.
The Average function differs from the Avg function (see
), which returns the average of values in a single value list. The
Average function can take multiple metrics as inputs and average the values of the metrics. You can use this function to compute and display the average of two or more metrics on a report.
© 2012 MicroStrategy, Inc.
Basic functions
99
2
Standard Functions MicroStrategy Functions Reference
Syntax
Average(Argument1, Argument2,..., ArgumentN)
Where:
The arguments must be metrics or constants.
Avg (average)
Avg calculates the sum of a single value list and divides the result by the number of values in the list. This returns the average (arithmetic mean) of the listed values.
Avg is often used to create subtotals and metrics based on fact data. This is a group-value function.
Syntax
Avg<Distinct, FactID, UseLookupForAttributes>(Argument)
Where:
•
Argument is an attribute, fact, or metric representing a list of numbers.
•
Distinct is a TRUE/FALSE parameter that allows you to use all values in the calculation or to calculate using only the unique values.
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
•
UseLookupForAttributes is a TRUE/FALSE parameter that can be used when performing an aggregation of an attribute. The Count function is most commonly used to aggregate attributes. For information on this parameter, including an example of using it with the Count function, see
Usage notes
The Avg function ignores NULL values but uses zero values in its calculation.
Example
Example 1: In this simple example the average of a value list containing the values (4,9,2,9) is calculated as follows:
100
Basic functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
(4+9+2+9)/4 = 6
Example 2: This report obtains the average salary for employees in each region. The report contains the attributes Region, Employee, and Salary as well as the metric Average Salary. A report filter limits the regions displayed to Northeast and Southeast. The metric Average Salary is defined as follows:
Avg(Salary){Region}
The function sums all salaries within a region and divides by the number of values, resulting in the regional average salary.
For further examples of using the Avg function, see
Example 1: Transformed fact , page 7
Example 2: Compound metric , page 7
Count
Count returns the number of elements in a list of values. This is a group-value function.
Syntax
Count<Distinct, FactID, UseLookupForAttributes, Null>
(Argument)
Where:
•
Argument is an attribute, fact, or metric representing a list of values.
•
Distinct is a TRUE/FALSE parameter that allows you to count all elements in a list or only the unique elements.
© 2012 MicroStrategy, Inc.
Basic functions
101
2
Standard Functions MicroStrategy Functions Reference
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
•
UseLookupForAttributes is a TRUE/FALSE parameter that can be used when performing an aggregation of an attribute:
If you set this parameter to TRUE, the aggregation is done for the unique set of attribute elements, excluding any duplicates caused by additional attributes on the report.
If you set this parameter to FALSE, the aggregation is done for all elements of an attribute, including duplicate elements that can be included by displaying additional attributes on a report.
For an example of how to use this parameter, see
Performing counts of attributes, page 103
Example
This example creates a report that calculates the count of employees in each region. The report contains the attributes Region and Employee, and the metric # of Employees. A report filter limits the regions displayed to Central,
South, Southeast, and Southwest. The metric # of Employees is defined as follows: Count(Employee){Region, ~}.
The function counts each entry within a region and returns the last number in the count.
102
Basic functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Performing counts of attributes
While most functions are commonly used with facts and metrics, the Count function is commonly used to count the number of elements for an attribute.
For example, the report shown below displays the customer revenue for each item they purchased.
This report also uses two derived metrics to display the following count information:
• Number of Customers
: This derived metric displays the count of customers. The expression used to define the derived metric is
Count<UseLookupForAttributes=True>(Customer){}. By defining the parameter UseLookupForAttributes=True, the Count function ignores any multiple listings of each Customer attribute element. In the report shown above, each separate item is ignored and only the unique attribute elements for Customer are counted.
• Number of Customer Purchases
: This derived metric displays the count of customer purchases. The expression used to define the derived metric is Count<UseLookupForAttributes=
False>(Customer){}. By defining the parameter
UseLookupForAttributes=False, the Count function counts each listing of the Customer attribute element. In the report shown above, each separate item is counted, which provides a count of customer purchases.
For information on creating derived metrics, along with other OLAP Services features, see the OLAP Services Guide.
© 2012 MicroStrategy, Inc.
Basic functions
103
2
Standard Functions
First
MicroStrategy Functions Reference
Returns the result of an aggregate applied over a set of rows that ranks as the first within a specified order. This is a group-value function that shares the sort by capability of the OLAP functions.
Syntax
First<FactID, SortBy>(Argument)
Where:
•
Argument is an attribute, fact, or metric representing a list of values.
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
•
SortBy is a parameter that allows you to define the attribute or metric on which to sort the data.
Example
The First function is often used to define subtotals. In this example, the First function defines the subtotal for the metric units received, returning the units received for the first quarter containing a value in 2003. The expression defines the subtotal as follows:
First<SortBy= (Day, Month, Quarter, Year) >([Units
Received]){@}
104
Basic functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Argument is the metric to which the subtotal is applied.
For detailed instructions on creating and applying user-defined subtotals, see the MicroStrategy Advanced Reporting Guide.
GeoMean (geometric mean)
This function can be used to find the average for a set of values contributing to a product. While the Avg function is used to find the arithmetic mean for a set of values contributing to a sum, GeoMean can be used to determine the average growth rate for a given compound interest with variable rates.
This function takes the product of a set of values of size N and returns the Nth root of the result (also known as geometric mean). GeoMean is a group-value function.
Syntax
GeoMean <FactID>(Argument)
Where:
•
Argument is an attribute, fact, or metric representing a list of numbers.
© 2012 MicroStrategy, Inc.
Basic functions
105
2
Standard Functions MicroStrategy Functions Reference
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
Expression
GM y
= n y
1 y
2 y
3
y n
Usage notes
This function returns an error if a value in the value list is negative.
Example
Suppose you have an investment that earns 10% the first year, 60% the second year, and 20% the third year, and you want to answer the question
“What is its average rate of return?” You do not want to use the Avg function to obtain the arithmetic mean, because these numbers show that in the first year your investment was multiplied by 1.10, in the second year by 1.60, and in the third year by 1.20. The average is the geometric mean of these three numbers. This can be understood as looking for a constant that you can multiply each year’s investment by, and get the same result as multiplying the first year by 1.10, the second year by 1.60, and so forth. This constant is the geometric mean.
(1.10 * 1.60 * 1.20)
1/3
= 1.283
The geometric mean is 1.283, so the average rate of return is about 28%.
Greatest
Returns the larger of two or more values. The Greatest function differs from the Max function, which returns the largest value in a single value list.
Greatest can take multiple lists as input and compare the elements in the lists. It is used for comparisons between metrics.
Syntax
Greatest(Argument1, Argument2,..., ArgumentN)
Where:
The arguments must be metrics.
106
Basic functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Example
This simple example illustrates how data is returned by the Greatest function.
Given two value lists, the function compares the values in each position in the list and returns a list containing the highest numbers from each position.
List 1
21
18
42
30
7
List 2
50
3
22
6
20
Result List
50
18
42
30
20
Last
The Last function returns the last value in a sorted set of values. It is often used to define subtotals, as shown in the example below. This is a group-value function.
Syntax
Last<FactID, SortBy>(Argument)
Where:
•
Argument is an attribute, fact, or metric representing a list of values.
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
•
SortBy is a parameter that allows you to define the attribute or metric on which to sort the data.
© 2012 MicroStrategy, Inc.
Basic functions
107
2
Standard Functions MicroStrategy Functions Reference
Example
In this example, Last is used in the subtotal for the metric End on Hand, returning the total items on hand in the last quarter of 2003. The subtotal expression is defined as follows:
Last<SortBy= (Day, Month, Quarter, Year) >(End on Hand)
{@ }
For detailed instructions on creating and applying user-defined subtotals, see the MicroStrategy Advanced Reporting Guide.
Least
This function returns the smaller of two or more values. The Least function differs from the Min function, which returns the smallest value in a single value list. Least can take multiple lists as input and compare the elements of the lists. It is used for comparisons between metrics. This is a single-value function.
108
Basic functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Syntax
Least(Argument1, Argument2,..., ArgumentN)
Where:
The arguments must be metrics.
Example
This simple example illustrates how data is returned by the Least function.
Given two values lists, the function compares the values at each position in the lists and returns a list of the lowest values from each position.
List 1
21
18
42
30
7
List 2
50
3
22
6
20
Result List
21
3
22
6
7
Max (maximum)
Max returns the largest value in a list of values. For example, it can be used on a list of prices to determine the maximum cost of an item. This is a group-value function.
To compare the highest values in multiple lists of values, use the
Greatest function.
Syntax
Max <FactID, UseLookupForAttributes>(Argument)
Where:
•
Argument is an attribute, fact or metric representing a list of numbers.
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
Basic functions
109
© 2012 MicroStrategy, Inc.
2
Standard Functions MicroStrategy Functions Reference
•
UseLookupForAttributes is a TRUE/FALSE parameter that can be used when performing an aggregation of an attribute. The Count function is most commonly used to aggregate attributes. For information on this parameter, including an example of using it with the Count function, see
Example
This example shows a report displaying the cost range of items within a subcategory. The Max function is used to determine the highest cost of an item within a subcategory. The metric, Maximum Unit Cost, is defined as follows:
Maximum([Unit Cost]) {~}
The metric is placed on a report with the attributes Category and
Subcategory and the metric Minimum Unit Cost. The resulting report appears as follows:
110
Basic functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Median
Standard Functions 2
Median returns the value in the middle of a set of listed values. The result will be greater than half the values in the list and less than the other half. The median can be used as an alternative to the arithmetic mean when handling values that are not evenly distributed or contain outliers. This is a group-value function.
Syntax
Median <FactID>(Argument}
Where:
•
Argument is an attribute, fact or metric representing a list of numbers.
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
Usage notes
This function provides a location measure: the value returned has a relative position with regard to other values in the list. Mode is another function that provides a location measure.
Example
This example shows a report built to obtain the median age of employees within each region. The report includes the attributes Region, Employee, and
Employee Age, and the metric Median Age. A report filter limits the regions displayed to Mid Atlantic, Northeast, and Southeast. The metric Median Age is defined as follows:
Median([Employee Age){Region,~}
© 2012 MicroStrategy, Inc.
Basic functions
111
2
Standard Functions MicroStrategy Functions Reference
The function evaluates the list of employee ages within a region and selects a value in the middle of the value list.
For another example of using the Median function, see
.
Min (minimum)
Min returns the lowest value in a list of values. For example, it can be used on a list of prices to determine the minimum cost of an item. This is a group-value function.
To compare the lowest values in multiple lists of values, use the
Least function.
Syntax
Min <FactID, UseLookupForAttributes>(Argument)
Where:
•
Argument is an attribute, fact, or metric representing a list of numbers.
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
112
Basic functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
•
UseLookupForAttributes is a TRUE/FALSE parameter that can be used when performing an aggregation of an attribute. The Count function is most commonly used to aggregate attributes. For information on this parameter, including an example of using it with the Count function, see
Example
This example shows a report displaying the cost range of items within a subcategory. The Min function is used to determine the lowest cost of an item within a subcategory. The metric Minimum Unit Cost is defined as follows:
Minimum([Unit Cost]) {~}
The metric is placed on a report with the attributes Category and
Subcategory and the metric Maximum Unit Cost.
© 2012 MicroStrategy, Inc.
Basic functions
113
2
Standard Functions
Mode
MicroStrategy Functions Reference
Returns the most frequently occurring value in a given list. This is a group-value function.
Syntax
Mode <FactID, IsRemovable>(Argument)
Where:
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
•
IsRemovable is a parameter that determines whether the Mode of a single value returns that value or a NULL value, as described below:
IsRemovable=True returns the single value as the result of the
Mode function. For example, Mode<IsRemovable=True>(4) would return the value 4.
IsRemovable=False returns a NULL value as the results of the
Mode function when a single value is supplied. For example,
Mode<IsRemovable=False>(4) would return NULL.
If multiple values are supplied to the Mode function, the IsRemovable parameter has no effect on the result of the Mode function.
•
Argument is an attribute, fact, or metric representing a list of numbers.
Usage notes
•
This function provides a location measure: the value returned has a relative position with regard to other values in the list. Median is another function that provides a location measure.
•
Returns a NULL if there are no recurring values in the range or list.
Example
This example shows a report that retrieves the mode of the unit cost for items in a subcategory. The report returns the most frequently repeated unit cost within the various subcategories, and, in the cases of Electronics, TVs, and
Video Equipment, it returns a NULL value, because there are no recurring unit cost values for them. The report contains the attributes Category and
Subcategory, and the metric Mode Unit Cost. A report filter limits the categories displayed to Books and Electronics. The Mode Unit Cost metric is defined as follows:
114
Basic functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Mode([Unit Cost])
The formula listed above uses the Unit Cost fact rather than the Unit
Cost metric.
Multiply
Multiply returns the product of two or more values. This function differs from the Product function (see
), which returns the product of values in a single value list. The Multiply function can take multiple metrics as inputs and multiply the values of the metrics.
You can also construct these types of metrics using the times operator (see
) rather than the Multiply function.
Syntax
Multiply(Argument1, Argument2,..., ArgumentN)
Where:
The arguments must be metrics or constants.
© 2012 MicroStrategy, Inc.
Basic functions
115
2
Standard Functions MicroStrategy Functions Reference
Example
In the report shown below, the Unit Profit metric uses the formula
Multiply([Unit Price],[Units Sold]) to return the revenue for each item. This report was created in the MicroStrategy Tutorial project.
Product
Multiplies all values in a list. This is a group-value function.
Syntax
Product<FactID>(Argument)
Where
•
Argument is an attribute, fact, or metric representing a list of numbers.
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
Example
Given a value list containing the values (1,2,3,4), the product calculates as
1*2*3*4 = 24.
116
Basic functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
StDevP (standard deviation of a population)
The standard deviation is a value which shows how widely values in a population differ from the mean. It is useful for comparing different sets of values with a similar mean.
StDevP returns the standard deviation of a population represented by list of values. It is a group-value function.
Syntax
StDevP <FactID >(Argument)
Where:
•
Argument is an attribute, fact, or metric representing a list of numbers.
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
Expression
n
x
2
– n
2
x
2
----------------------
Usage notes
•
For this function, arguments correspond to an entire population as opposed to a population sample. For population samples, see Standard
deviation of a sample.
•
When very large population samples are used, this function and the
Standard deviation of a sample function return approximately equal results.
Example
This example shows a report where the standard deviation of the revenue is calculated. This calculation is based on the assumption that the list of values supplied in the metric represents the entire population of the data for which you want to obtain the standard deviation. The calculation is based on the revenue values for each state within a region and calculated at the region level.
Compare this example report to the example for StDev to see the different values returned when calculating for a population as opposed to a sample.
Basic functions
117
© 2012 MicroStrategy, Inc.
2
Standard Functions MicroStrategy Functions Reference
The report contains the attributes Customer Region and Customer State, and the metrics Total Revenue and StDevP. A report filter limits the regions displayed to South, Northwest, and Southwest. The definition of the StDevP metric is as follows:
StDevP([Total Revenue]){[Customer Region], ~}
StDev (standard deviation of a sample)
The standard deviation is an indicator of how widely values in a group differ from the mean. It is useful for comparing different sets of values with a similar mean.
StDev returns the standard deviation of a population based on a sample.
This is a group-value function.
Syntax
StDev <Distinct, FactID>(Argument)
Where:
•
Argument is an attribute, fact, or metric representing a list of numbers.
118
Basic functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
•
Distinct is a TRUE/FALSE parameter that allows you to calculate using all values in the list or only the unique values.
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
Expression
n
x
2
–
x
2
Usage notes
•
In this function, arguments correspond to a population sample as opposed to the entire population. For entire populations, see Standard
deviation of a population.
•
When very large population samples are used, this function and the
Standard deviation of a population function return approximately equal results.
Example
This example shows a report where the standard deviation of the revenue is calculated. This calculation is based on the assumption that the list of values supplied in the metric represents a sample of the data for which you want to obtain the standard deviation. The calculation is based on the revenue values for each state within a region and calculated at the region level.
Compare this example report to the example for StDevP to see the different values returned when calculating for a population as opposed to a sample.
The report contains the attributes Customer Region and Customer State, and the metrics Total Revenue and StDev. A report filter limits the regions displayed to South, Northwest, and Southwest. The definition of the StDev metric is as follows:
StDev([Total Revenue]){[Customer Region], ~}
Basic functions
119
© 2012 MicroStrategy, Inc.
2
Standard Functions MicroStrategy Functions Reference
Sum
Returns the sum of all numbers in a list of values. This function is commonly used in metrics and subtotals. Sum is a group-value function.
Syntax
Sum <Distinct, FactID, UseLookupForAttributes>(Argument)
Where:
•
Argument is an attribute, fact, or metric representing a list of numbers.
•
Distinct is a TRUE/FALSE parameter that allows you to calculate using all values in the list or only the unique values.
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
•
UseLookupForAttributes is a TRUE/FALSE parameter that can be used when performing an aggregation of an attribute. The Count function is most commonly used to aggregate attributes. For information on this parameter, including an example of using it with the Count function, see
120
Basic functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Example
In this example, the metric Regional Revenue is defined as follows:
Sum(Revenue) {[Customer Region], ~}
This simple report uses the attributes Customer Region and Customer State, and the metrics Revenue and Regional Revenue to generate a report showing the sum of the revenue for several regions. A report filter limits the regions displayed to Northeast, Northwest, and Southeast.
VarP (variance of a population)
Variance is a measure of how spread out a set of values is.
VarP returns this measure based on an entire population. This is a group-value function.
Syntax
VarP <FactID>(Argument)
Where:
•
Argument is an attribute, fact, or metric representing a list of numbers.
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
© 2012 MicroStrategy, Inc.
Basic functions
121
2
Standard Functions MicroStrategy Functions Reference
Expression
2
–
x
2 n x
----------------------n
2
Usage notes
For this function, arguments relate to an entire population as opposed to a population sample.
Example
Variance is calculated as the average squared deviation of each number from its mean. This example creates a report in which the variance of the units sold in the subcategories within a category is calculated with the assumption that the data provided represents the entire population.
Compare this example report to the example for variance of a sample to see the different values returned when calculating for a population as opposed to a sample.
The report includes the attributes Category and Subcategory, and the metrics
Units Sold and VarP by Category. A report filter limits the categories displayed to Books and Movies. The VarP by Category metric is defined as follows:
VarP([Units Sold]) {Category, ~}
122
Basic functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Var (variance of a sample)
Variance is a measure of how spread out a set of values is. It is calculated as the average squared deviation of each number from its mean.
This function calculates the variance based on a sample of a population. This is a group-value function.
Syntax
Var <Distinct, FactID>(Argument)
Where:
•
Argument is an attribute, fact, or metric representing a list of numbers.
•
Distinct is a TRUE/FALSE parameter that allows you to calculate using all values in the list or only the unique values.
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
Expression
2
–
x
2 n x n n 1
Usage notes
Assume when using this function that arguments constitute a population sample, as opposed to a entire population.
Example
This example creates a report in which the variance of the units sold in the subcategories within a category is calculated, with the assumption that the data provided is a sample.
Compare this example report to the example for variance of a population to see the different values returned when calculating for a population as opposed to a sample.
The report includes the attributes Category and Subcategory, and the metrics
Units Sold and Var by Category. A report filter limits the categories displayed to Books and Movies. The Var by Category metric is defined as follows:
Var([Units Sold]) {Category, ~}
Basic functions
123
© 2012 MicroStrategy, Inc.
2
Standard Functions MicroStrategy Functions Reference
Date and time functions
This section describes the date and time functions. These functions are not supported by the Analytical Engine, so they must be calculated by the database.
The MicroStrategy Analytical Engine does not calculate date and time functions. If your database does not include SQL syntax support for a date and time function, the function cannot be calculated in your environment.
For information on whether your database supports various date and time functions, refer to
Appendix A, MicroStrategy and Database Support for
The results returned by the date/time functions may differ depending on the way your database stores and interprets dates, for example, whether Monday is considered the first or second day of the week.
AddDays
AddDays is used to calculate dates that occur N days before or after a given date. It returns this information in the form of a date or timestamp.
Syntax
AddDays(Date/Time,Offset)
124
Date and time functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Where:
•
Date/Time is the input date or timestamp.
•
Offset is an integer number of days to add.
For information on whether your database supports various date and time functions, refer to
Appendix A, MicroStrategy and Database Support for
Example
AddDays('2004-07-29', 4) = 2004-08-02
AddDays('2004-07-29 02:00:00', 4) = 2004-08-02 02:00:00
AddDays('2004-03-01', -4) = 2004-02-26
AddMonths
AddMonths is used to calculate dates that occur N months before or after a given date. It returns this information in the form of a date or timestamp.
If the new date does not occur in the new month, the last date of the new month is returned.
Syntax
AddMonths(Date/Time,Offset)
Where:
•
Date/Time is the input date or timestamp.
•
Offset is an integer number of months to add.
For information on whether your database supports various date and time functions, refer to
Appendix A, MicroStrategy and Database Support for
© 2012 MicroStrategy, Inc.
Date and time functions
125
2
Standard Functions MicroStrategy Functions Reference
Example
AddMonths('2004-07-29', 3) = 2004-10-29
AddMonths('2004-07-29 10:00:00', 3) = 2004-10-29
10:00:00
AddMonths('2003-03-31', -1) = 2003-02-28
CurrentDate
Returns the current date as provided by the database timer.
This function does not take input variables.
Syntax
CurrentDate()
For information on whether your database supports various date and time functions, refer to
Appendix A, MicroStrategy and Database Support for
CurrentDateTime
Returns the current date and time as provided by the database timer.
This function does not take input variables.
Syntax
CurrentDateTime()
For information on whether your database supports various date and time functions, refer to
Appendix A, MicroStrategy and Database Support for
126
Date and time functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
CurrentTime
Returns the current time as provided by the database timer.
This function does not take input variables.
Syntax
CurrentTime()
For information on whether your database supports various date and time functions, refer to
Appendix A, MicroStrategy and Database Support for
Date
Returns only the date portion of the date-time column. The time is truncated, not rounded.
Syntax
Date(Date/Time)
Where:
Date/Time is the input date or timestamp.
For information on whether your database supports various date and time functions, refer to
Appendix A, MicroStrategy and Database Support for
Example
Date('2004-07-29') = 2004-07-29
Date('2004-07-29 02:00:00') = 2004-07-29
DayofMonth
Returns a number corresponding to the day of the month of the date provided. The value returned is an integer between 1 and 31.
Date and time functions
127
© 2012 MicroStrategy, Inc.
2
Standard Functions MicroStrategy Functions Reference
Syntax
DayofMonth(Argument)
Where:
Argument is a metric representing a list of dates.
For information on whether your database supports various date and time functions, refer to
Appendix A, MicroStrategy and Database Support for
Example
Input is the date 7/11/2002; output is the integer 11.
Input is the date 2003/10/10; output is the integer 10.
DayofWeek
Returns the number of the day in the week corresponding to the input date.
The return value is an integer between 1 and 7.
Syntax
DayofWeek(Argument)
Where:
Argument is a metric representing a list of dates.
For information on whether your database supports various date and time functions, refer to
Appendix A, MicroStrategy and Database Support for
Example
Input is the date 5/16/2003; output is the integer 6.
Input is the date 2003/9/9; output is the integer 3.
128
Date and time functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
DayofYear
Returns the number of the day in the year of the input date. The return value is an integer between 1 and 365.
Syntax
DayofYear(Argument)
Where:
Argument is a metric representing a list of dates.
For information on whether your database supports various date and time functions, refer to
Appendix A, MicroStrategy and Database Support for
Example
Input is the date 1/16/2003; output is the integer 16.
Input is the date 2/17/2003; output is the integer 48.
DaysBetween
Returns the difference in days between two given dates as an integer value.
The calculation of the difference is based on the number of day boundaries crossed, not the number of twenty-four hours periods elapsed. If the first date argument is later than the second date argument, the result is a negative number. The result does not display the time stamps, as they are truncated before performing the calculation.
Syntax
DaysBetween(Date/Time1, Date/Time2)
Where:
•
Date/Time1 is the start date.
•
Date/Time2 is the end date.
© 2012 MicroStrategy, Inc.
Date and time functions
129
2
Standard Functions MicroStrategy Functions Reference
For information on whether your database supports various date and time functions, refer to
Appendix A, MicroStrategy and Database Support for
Examples
DaysBetween('2004-07-29', '2004-07-25') = -4
DaysBetween('2004-07-29 02:00:00', '2004-07-31
01:00:00') = 2
Hour
Returns the integer value for the hour of the input time. The return value is an integer between 0 and 23.
Syntax
Hour(Argument)
Where:
Argument is a metric representing a list of dates and times.
For information on whether your database supports various date and time functions, refer to
Appendix A, MicroStrategy and Database Support for
Example
Input is the time 9:45 am; output is the integer 9.
Input is the time 11:10 pm; output is the integer 23.
Millisecond
Returns the integer value for the millisecond of the input time.
Syntax
Millisecond(Argument)
130
Date and time functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Where:
Argument is a metric representing a list of dates and times.
For information on whether your database supports various date and time functions, refer to
Appendix A, MicroStrategy and Database Support for
Minute
Returns the integer value for the minute of the input time. The return value is an integer between 0 and 59.
Syntax
Minute(Argument)
Where:
Argument is a metric representing a list of dates and times.
For information on whether your database supports various date and time functions, refer to
Appendix A, MicroStrategy and Database Support for
Example
Input is the time 9:45 am; output is the integer 45.
Input is the time 11:10 pm; output is the integer 10.
Month
Returns the number of the month in the year of the input date. The return value is an integer between 1 and 12.
Syntax
Month(Argument)
© 2012 MicroStrategy, Inc.
Date and time functions
131
2
Standard Functions MicroStrategy Functions Reference
Where:
Argument is a metric representing a list of dates.
For information on whether your database supports various date and time functions, refer to
Appendix A, MicroStrategy and Database Support for
Example
Input is the date 5/16/2003; output is the integer 5.
Input is the date 2003/9/3; output is the integer 9.
MonthEndDate
Returns the date of the last day of the month in which a date or timestamp occurs.
Syntax
MonthEndDate(Date/Time)
Where:
Date/Time is the input date or timestamp.
For information on whether your database supports various date and time functions, refer to
Appendix A, MicroStrategy and Database Support for
Example
MonthEndDate('2004-07-29') = 2004-07-31
MonthEndDate('2004-07-29 02:00:00') = 2004-07-31
MonthStartDate
Returns the date of the first day of the month in which a date or timestamp occurs.
132
Date and time functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Syntax
MonthStartDate(Date/Time)
Where:
Date/Time is the input date or timestamp.
For information on whether your database supports various date and time functions, refer to
Appendix A, MicroStrategy and Database Support for
Example
MonthStartDate('2004-07-29') = 2004-07-01
MonthStartDate('2004-07-29 02:00:00') = 2004-07-01
MonthsBetween
Returns the difference in months between two dates as an integer value. The difference is calculated by the number of months elapsed and not by the number of month boundaries crossed. If the first date argument is later than the second date argument, the result is a negative number. The result does not display the timestamps, as they are truncated before performing the calculation.
Syntax
MonthsBetween(Date/Time1, Date/Time2)
Where:
•
Date/Time1 is the start date.
•
Date/Time2 is the end date.
For information on whether your database supports various date and time functions, refer to
Appendix A, MicroStrategy and Database Support for
© 2012 MicroStrategy, Inc.
Date and time functions
133
2
Standard Functions MicroStrategy Functions Reference
Example
MonthsBetween('2004-07-29', '2004-02-28') = -5
MonthsBetween('2004-07-29 02:00:00', '2004-09-29
01:00:00') = 2
Quarter
Returns the number of the quarter in the year of the input date. The return value is an integer between 1 and 4.
Syntax
Quarter(Argument)
Where:
Argument is a metric representing a list of dates.
For information on whether your database supports various date and time functions, refer to
Appendix A, MicroStrategy and Database Support for
Example
Input is the date 5/16/2003; output is the integer 2.
Input is the date 2003/9/3; output is the integer 4.
Second
Returns the integer value for the second of the input time. The return value is an integer between 0 and 59.
Syntax
Second(Argument)
Where:
Argument is a metric representing a list of dates and times.
134
Date and time functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
For information on whether your database supports various date and time functions, refer to
Appendix A, MicroStrategy and Database Support for
Example
Input is the time 9:45:13 am; output is the integer 13.
Input is the time 11:10:47 pm; output is the integer 47.
Week
Returns the number of the week in the year of the input date. The return value is an integer between 1 and 54.
Syntax
Week(Argument)
Where:
Argument is a metric representing a list of dates.
For information on whether your database supports various date and time functions, refer to
Appendix A, MicroStrategy and Database Support for
Example
Input is the date 5/16/2003; output is the integer 20.
Input is the date 2003/9/9; output is the integer 37.
Year
Returns the year of the input date. The return value is an integer between
1900 and 9999.
Syntax
Year(Argument)
© 2012 MicroStrategy, Inc.
Date and time functions
135
2
Standard Functions MicroStrategy Functions Reference
Where:
Argument is a metric representing a list of dates.
For information on whether your database supports various date and time functions, refer to
Appendix A, MicroStrategy and Database Support for
Example
Input is the date 5/16/2003; output is the integer 2003.
Input is the date 2002/9/9; output is the integer 2002.
YearEndDate
Returns the date of the last day of the year in which a date or timestamp occurs.
Syntax
YearEndDate(Date/Time)
Where:
Date/Time is the input date or timestamp.
For information on whether your database supports various date and time functions, refer to
Appendix A, MicroStrategy and Database Support for
Example
YearEndDate('2004-07-29') = 2004-12-31
YearEndDate('2004-07-29 02:00:00') = 2004-12-31
YearStartDate
Returns the date of the first day of the year in which a date or timestamp occurs.
136
Date and time functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Syntax
YearStartDate(Date/Time)
Where:
Date/Time is the input date or timestamp.
For information on whether your database supports various date and time functions, refer to
Appendix A, MicroStrategy and Database Support for
Examples
YearStartDate('2004-07-29') = 2004-01-01
YearStartDate('2004-07-29 02:00:00') = 2004-01-01
Internal functions
The following are internal function types:
•
MicroStrategy Apply, or Pass-through, functions provide access to functionality that is not standard in MicroStrategy but is available in many Relational Database Management Systems (RDBMS). These
MicroStrategy functions act as containers for non-standard SQL expressions passed to your warehouse database. The Microstrategy Apply functions are listed below:
ApplyAgg
defines simple metrics or facts using group-value aggregation functions.
ApplyComparison
defines custom filters using comparison operators.
ApplyLogic
defines custom filters using logical operators.
ApplyOLAP
defines compound functions using database-specific
OLAP functions such as Rank and RunningSlope.
ApplySimple
uses simple operators and functions like “+”, “-”, and
“*” to perform single-value operations at the database level.
© 2012 MicroStrategy, Inc.
Internal functions
137
2
Standard Functions MicroStrategy Functions Reference
• Banding functions
are used to differentiate displayed data on a report.
You can divide data into bands in the following ways:
Banding
distributes the values into bands of equal size.
BandingC
distributes values into a specified number of bands.
BandingP
distributes values into bands based on specific intervals of values.
• Case functions
return specified data based on the evaluation of user-defined conditions.
Each of these functions is described in detail in the following subsections.
Apply (Pass-Through) functions
Microstrategy Apply functions provide access to functions or syntactic constructs that are not standard in MicroStrategy but are provided by various Relational Database Management System (RDBMS) platforms.
MicroStrategy strongly advises against using Apply functions when standard Microstrategy functions can be used to achieve the same goal, because using RDBMS functions effectively bypasses the validations and other benefits of MicroStrategy products. Using Apply functions is recommended only when corresponding functionality does not exist in the MicroStrategy product. When you need to use an
Apply function, Microstrategy encourages you to submit an enhancement request for inclusion of the desired feature in a future product release.
Syntax common to Apply functions
While each Apply function has its own syntax, the Apply functions share several syntactic features:
•
The “#n” code in Apply function syntax serves as placeholders for the
MicroStrategy objects being passed to your database. The index for referencing these objects begins with 0 and increases by 1 for each successive object passed. For example, ApplySimple("#0 *
#1",[col1],[col2]) indicates that two items, col1 and col2, referenced as #0 and #1, respectively, are being passed to your database to be multiplied together (by the database). If the number of references in an Apply function (e.g., #0, #1, and so forth) exceeds the number of
138
Internal functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2 objects passed in that function, MicroStrategy passes the last available object in place of the extra reference(s). For example,
ApplySimple("#0 * #1 * #2 * #3",[col1],[col2]) uses two more references than there are arguments to pass, so MicroStrategy passes #2 and #3, the extra references, as col2, the last available object in the list.
•
To use # as a character rather than a placeholder, use four # characters in a row. See the syntax below for an example.
ApplyComparison(UPPER(#0) like
‘Z####%’, Country@DESC)
The SQL for the function is:
Select a.11[COUNTRY_ID] AS COUNTRY_ID from [LU_COUNTRY] a11 where upper(a11.[COUNTRY_NAME]) like ‘Z#%’
•
Do not use form groups for the attribute form expression when using
Apply functions, because form groups are ignored by the Analytical
Engine. Instead, use a single form. For example, instead of using
Customer@Name, where Name is defined to contain Customer’s first name, middle name, and last name, use ID or any other single form.
For more general information on Apply functions as well as an example, see
Apply (Pass-through) functions, page 11
ApplyAgg
The ApplyAgg function is used to define simple metrics or facts by using database-specific, group-value functions. The ApplyAgg function itself is a group-value function and accepts facts, attributes, and metrics as input.
Syntax
ApplyAgg()
Accepts facts, attributes, and metrics as input.
All placeholders must begin with #0 and increase in increments of 1.
Internal functions
139
© 2012 MicroStrategy, Inc.
2
Standard Functions MicroStrategy Functions Reference
Example
ApplyAgg(“Regrsxx(#0,#1)”, [Argument 1], [Argument 2]
{~+}
ApplyComparison
ApplyComparison is used to define a filter by populating the WHERE clause in the SQL passed to your RDBMS, and can take facts, attributes, and metrics as input.
The ApplyComparison function is used with RDBMS comparison operators such as >, like, and In.
Syntax
ApplyComparison()
Example
ApplyComparison ("#0>#1", Store@ID,2)
For another example of the ApplyComparison function, see
ApplyComparison used to check a prompted date, page 12
.
ApplyLogic
The ApplyLogic function is used to define custom filters. It is used with logical operators such as AND and OR. ApplyLogic is a logical function.
Syntax
ApplyLogic()
Accepts logic (Boolean) values as input.
Example
ApplyLogic(“#0 and #1”, Year@ID>2003, Month@ID>200301)
140
Internal functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
ApplyOLAP
OLAP functions are group-value functions that take a set of data as input and generate a set of data as output, usually reordering the set according to some criteria.
ApplyOLAP is the MicroStrategy Apply function tool used for OLAP functionality when you wish to use the native capabilities of your RDBMS. It is used to define compound metrics via database-specific functions such as
Rank(). ApplyOLAP, like ApplySimple, is used to define metrics but differs in that it only accepts metrics as input.
Syntax
ApplyOLAP()
Accepts only metrics as input.
Example
ApplyOLAP(“RunningSlope(#0,#1)”, [Metric 1], [Metric 2])
ApplySimple
The ApplySimple function is a single-value function. It is used to insert any single-value, database-specific functions and simple operators directly into
SQL.
In general, ApplySimple can be used to create the following objects:
•
Attribute form
For any Apply function, the attribute form in the arguments should be a single form—not a form group. The engine ignores any definitions based on attribute forms.
•
Consolidation
•
Custom group
•
Fact
•
Metric
•
Subtotal
•
Transformation
Internal functions
141
© 2012 MicroStrategy, Inc.
2
Standard Functions MicroStrategy Functions Reference
For information about consolidations, custom groups, metrics, and subtotals, see the MicroStrategy Advanced Reporting Guide.
Syntax
ApplySimple()
Accepts facts, attributes, and metrics as input.
Examples of object creation
Expression type Examples
Attribute ApplySimple(“Datediff(YY,#0,getdate())”, [BIRTH_DATE]), in which [BIRTH_DATE] is an attribute
ApplySimple(“Months_between(sysdate,#0)”,[CURRENT_DT]), in which
[CURRENT_DT] is an attribute
Compound Metric ApplySimple(“Greatest(#0,#1,#2)”, Metric_1, Metric_2,Metric_3)
ApplySimple(" CASE WHEN #0 between 0 and 100000 THEN 'Low' WHEN #0 between 100001 and 200000 THEN 'Med' ELSE 'High' END ", Sum(Revenue){~})
Examples in custom expressions
•
ApplySimple("Datediff(YY,#0,getdate())",
[BIRTH_DATE])
•
ApplySimple("Months_between(sysdate,#0)",
[CURRENT_DT])
Examples: Incorrect usage
•
ApplySimple("Sum(#0)",[Column 1])
•
ApplySimple("Count(#0)",[Column 2])
The two examples immediately above are incorrect and should not be used in your application because of the following two reasons:
•
ApplySimple is a single-value function and therefore can only be used with single-value functions. Sum and Count are both group-value functions and therefore should not be used with ApplySimple.
•
Sum and Count are both MicroStrategy functions and are not database-specific; therefore, they should not be used with ApplySimple or any other Apply functions.
142
Internal functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Banding functions
Banding functions are used to group data on a report so that it is both more comprehensible and aesthetically pleasing than when it is displayed as one contiguous list. MicroStrategy provides different banding options for you to use, depending on how you want to divide your data. The banding functions, their syntaxes, and examples are listed below.
For information on banding functions in custom groups, refer to the
MicroStrategy Advanced Reporting Guide.
Banding
This function maps metric values that fall within a certain range to a particular integer band value. The range and band values are determined by the parameter input to the function. For example, if 5,000 is the specified range, the dollar sales are shown in bands of 0 - 5,000, 5,001 - 10,000,
10,001 - 15,000, and so on. Banding is a single-value function.
Syntax
Banding <HasResidue>(Argument, StartAt, StopAt, Size)
Where:
•
Argument is a metric.
•
StartAt and StopAt are real numbers specifying the full range of the values to be placed in bands.
•
Size is a real number indicating the width of each band.
•
HasResidue is a TRUE/FALSE parameter that defines whether an extra band is created for all values that do not fall within the StartAt and
StopAt values. Defining HasResidue as TRUE allows the function to create an additional band which is used to identify all values outside of the defined band range.
Usage notes
Values in the list that fall outside of the start and end values set in the function syntax are assigned a band of 0 (zero) in the report interface.
Internal functions
143
© 2012 MicroStrategy, Inc.
2
Standard Functions MicroStrategy Functions Reference
Example
The following example shows how the Banding function acts on report data.
In this case the total revenue for each city is used to divide the report data into bands:
•
The highest total revenue is 405, 367 (New York).
•
The lowest revenue is 668 (Cleveland).
The metric function syntax is as follows:
Banding([Total Revenue], 1, 410000, 20000)
•
Total Revenue is the metric, defined as Sum(Revenue), representing the list of values acted on by the Banding function.
•
1 is the value at which banding begins.
•
410,000 is the value at which banding ends.
•
20,000 is the size of the range of values included in each band.
Only part of the resulting report is displayed here.
The result is that 21 bands are created, each encompassing a range of 20,000 dollars of total revenue. To determine the number of bands, 410,000 is
144
Internal functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2 divided by 20,000 resulting in 20.5 (rounded to nearest integer, 21). Each band is given an integer value of between 1 and 21.
BandingC (banding count)
BandingC returns metric data grouped into a specified number of bands and assigns integer values to the resulting bands (for example, a total of 25,000 in dollar sales shown in five equal bands). This is a single-value function.
Syntax
BandingC <HasResidue>(Argument, StartAt, StopAt,
BandCount)
Where:
•
Argument is a metric.
© 2012 MicroStrategy, Inc.
Internal functions
145
2
Standard Functions MicroStrategy Functions Reference
•
BandCount is a positive integer indicating the number of bands into which the total is divided.
•
StartAt and StopAt are real numbers specifying the full range of the values to be placed in bands.
•
HasResidue is a TRUE/FALSE parameter that defines whether an extra band is created for all values that do not fall within the StartAt and
StopAt values. Defining HasResidue as True allows the function to create an additional band which is used to identify all values outside of the defined band range.
Usage notes
Values that fall outside of the range indicated by the Start and Stop values are assigned a band of 0 (zero).
Example
The following example shows how the BandingC function acts on report data. This example uses the same set of values as the example for the
Banding function. Using the BandingC function, you can designate the number of bands created for the range of values.
The metric function syntax is as follows:
BandingC([Total Revenue], 1, 410000, 25)
Where:
•
Total Revenue is the metric, defined as Sum(Revenue), representing the list of values acted on by the BandingC function.
•
1 is the value at which banding begins.
•
410,000 is the value at which banding ends.
•
25 is the number of bands into which you want the values divided.
Only part of the resulting report is displayed here.
146
Internal functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
The result is that 20 bands of equal sizes are created. To determine the range of each band, 410,000 is divided by 25 resulting in bands of 16,400. Each band is given an integer value of between 1 and 25.
BandingP (banding points)
Returns metric data grouped into bands identified by user-specified boundary point values (for example, 0 - 5,000, 5,000 - 20,000, 20,000 -
30,000). This function assigns integer values to the resulting metric and allows you to create band intervals of varying widths. This is a single-value function.
Syntax
BandingP <HasResidue>(Argument, Boundary1,
Boundary2,..., BoundaryN)
© 2012 MicroStrategy, Inc.
Internal functions
147
2
Standard Functions MicroStrategy Functions Reference
Where:
•
Argument is a metric.
•
Boundary1 through BoundaryN are real numbers indicating the cut-off value for each band. Boundary1 is less than Boundary2, Boundary2 is less than Boundary3, and so on.
•
HasResidue is a TRUE/FALSE parameter that defines whether an extra band is created for all values that do not fall within the Boundary1 and
BoundaryN values. Defining HasResidue as TRUE allows the function to create an additional band which is used to identify all values outside of the defined band range.
Example
The following example shows how the BandingP function acts on report data.
This example again uses the same data set as in the previous examples
(Banding and BandingC). Using the BandingP function, you can designate the boundaries for each interval.
The metric function syntax is as follows:
BandingP([Total Revenue],
1,20000,40000,60000,80000,100000,410000)
Where:
•
Total Revenue is the metric, defined as Sum(Revenue), representing the list of values acted on by the BandingP function.
•
All other values specify the boundaries of an interval. There are six intervals defined as follows:
Band 1
: 1
[Total Revenue] < 20000
Band 2
: 20,000
[Total Revenue] < 40,000
Band 3
: 40,000
[Total Revenue] < 60,000
Band 4
: 60,000
[Total Revenue] < 80,000
Band 5
: 80,000
[Total Revenue] < 100,000
Band 6
: 100,000
[Total Revenue]
410,000
Only part of the resulting report is displayed here.
148
Internal functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Case functions
Case functions return specified data in a SQL query based on the evaluation of user-defined conditions. In general, a user specifies a list of conditions and corresponding return values. When MicroStrategy queries the data warehouse, the software determines which condition evaluates as true and then returns the value that the user has specified that corresponds to that condition. The case functions, their syntaxes, and examples are listed below.
Case
This function evaluates multiple expressions until a condition is determined to be true, then returns a corresponding value. If all conditions are false, a default value is returned. Case can be used for categorizing data based on multiple conditions. This is a single-value function.
© 2012 MicroStrategy, Inc.
Internal functions
149
2
Standard Functions MicroStrategy Functions Reference
Syntax
Case (Condition1, ReturnValue1,
Condition2,ReturnValue2,..., DefaultValue)
Where:
•
Condition1 is the first condition to evaluate. The condition can contain metrics, comparison and logical operators, and constants.
•
ReturnValue1 is a constant or metric value to return if the
Condition1 condition is TRUE.
•
Condition2 is the second condition to evaluate. The condition can contain metrics, comparison and logical operators, and constants.
•
ReturnValue2 is a constant or metric value to return if the
Condition2 condition is TRUE.
•
... represents any number of Conditions and Return Values that can be passed through this function.
•
DefaultValue is the information to return if none of the other conditions are TRUE.
Example
This example generates a report where if the revenue, represented by the
Total Revenue metric, is less than 300,000, the function returns a 0; if the revenue is less than 600,000, the function returns a 1; if revenue is any other value, the function returns a 2. The case metric is defined as follows:
150
Internal functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Case(([Total Revenue] < 300000), 0, ([Total Revenue] <
600000), 1, 2)
Difference between Case and If
The If function is very similar to the Case function. Each function takes a condition as an argument and returns a value depending on whether the condition is true or not. The Case function can evaluate multiple conditional arguments, while the If function can only evaluate one condition. However, the If function can be evaluated by either the SQL Engine or the Analytical
Engine, while the Case function is evaluated only by the Analytical Engine.
CaseV (case vector)
CaseV evaluates a single metric and returns different values according to the results. It can be used to perform transformations on a metric. For example, if provided a list of values ranging from 1 to 12, CaseV might return January for a value of 1, February for a value of 2, etc. This is a single-value function.
Syntax
CaseV (Argument, Value1, Result1, Value2, Result2, ...,
DefaultResult)
Where:
•
Argument is the metric against which all values are compared.
© 2012 MicroStrategy, Inc.
Internal functions
151
2
Standard Functions MicroStrategy Functions Reference
•
Value1 is the first value (constant or metric) to be evaluated.
•
Result1 is the information to return (constant or metric) if the Value1 value is equal to the value for the Metric.
•
Value2 is the second value (constant or metric) to be evaluated.
•
Result2 is the information to return (constant or metric) if the Value2 value is equal to the value for the Metric.
•
... represents any number of Conditions and Return Values that can be passed through this function.
•
DefaultResult is the information to return (constant or metric) if none of the other values are Equal to the Metric.
Usage notes
The metric or argument in the CaseV expression is always held as a float.
This means that even if the value is 2, it is held as 2.00000; and therefore 2 and 2.00000 are never considered equal. For this reason, it is best if you wrap the metric or argument in the integer function, for example,
CaseV(int(M1), 2, A,...).
Example
This simple example generates a report where if the Unit Profit for the item is
2, the function returns a 200; if the Unit Profit for the item is 3, the function returns a 300; if Unit Profit is any other value, the function returns a
1000000. Notice how a single metric, Unit Profit, is evaluated against multiple numeric values. The report contains the attribute Item and the metrics Unit Profit and CaseV. A report filter limits the items displayed to those in the subcategory Action. The CaseV metric is defined as follows:
CaseV ([Unit Profit], 2, 200, 3, 300, 1000000)
152
Internal functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Coalesce
Returns the value of the first non-null argument. Coalesce can be used to identify data in tables that may not be fully populated or in metric definitions.
Syntax
Coalesce (Argument1, Argument2,..., ArgumentN)
Where:
The arguments for the Coalesce function can be any expression that can be evaluated as null or not null.
Usage Notes
You can use the Coalesce function in defining a metric, but more often it is used with the Query Builder feature to support the inclusion of the Coalesce function in SQL queries. Refer to the example below for more detailed information.
Example
Your database has two tables T1 and T2 that include the column MONTH_ID with the format yyyymm. You want to filter on a specific month, but you are
© 2012 MicroStrategy, Inc.
Internal functions
153
2
Standard Functions MicroStrategy Functions Reference not sure which table has been populated with month data. In the Query
Builder Editor, you can filter your SQL query by creating the condition
Coalesce(T1.MONTH_ID, T2.MONTH_ID) = 200410. The WHERE clause of the SQL query checks for the first non-null MONTH_ID column and compares it to the value 200410.
For more information on Query Builder, see the MicroStrategy Advanced
Reporting Guide.
NULL/Zero functions
The NULL/Zero functions are often used to determine how NULLs and zeros are displayed on a report. They can also be used as a form of data validation to ensure meaningful results. For example, an otherwise invalid mathematical expression such as 5 + NULL can be changed to 5 + 0.
IsNotNull
Returns TRUE if value input is not NULL; otherwise, returns FALSE. This is a comparison function.
Syntax
IsNotNull(Argument)
Where:
Argument is a fact or metric.
Usage notes
The IsNull and IsNotNull functions work only with the data returned from the database. For example, if the database data is NULL, the IsNotNull function returns a FALSE. However, you may see NULL data when you manipulate a report after its original generation and that manipulation does not regenerate the data from the database. This can happen when you page by, for example, and the result includes a NULL.
154
NULL/Zero functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
IsNull
Standard Functions 2
Returns TRUE if the value is NULL; otherwise, returns FALSE. This is a comparison function.
Syntax
IsNull(Argument)
Where:
Argument is a fact or metric.
Usage notes
The IsNull and IsNotNull functions work only with the data returned from the database. For example, if the database data is NULL, the IsNotNull function returns a FALSE. However, you may see NULL data when you manipulate a report after its original generation and that manipulation does not regenerate the data from the database. This can happen when you page by, for example, and the result includes a NULL.
NullToZero
Converts a value of NULL to 0. If the value is not NULL, the original value is kept.
Syntax
NullToZero(Argument)
Where:
Argument is a fact or metric.
Example
In this simple example, the function NullToZero is applied to a list of values
(12, NULL, 97, 43, NULL). The resulting list is (12,0, 97, 43, 0). This function could be applied to a value list before it is acted on by another function such as Average so that NULL values in a list are included as list elements and factored into the average as zeros.
© 2012 MicroStrategy, Inc.
NULL/Zero functions
155
2
Standard Functions MicroStrategy Functions Reference
ZeroToNull
Converts a value of 0 to NULL. If the value is not 0, the original value is kept.
Syntax
ZeroToNull(Argument)
Where
Argument is a fact or metric.
Example
In this simple example, the function ZeroToNull is applied to a list of values
(12, 0, 97, 43, 0). The resulting list is (12, NULL, 97, 43, NULL). This function could be applied to a value list before it is acted on by another function such as Average so that zero values in a list are not included as list elements and therefore not factored into the average.
OLAP functions
OLAP functions are also known as relative functions. They take multiple elements from a list and return a new list of elements. The following applies to all OLAP functions:
•
SortBy is applied before the engine performs the calculation of an OLAP function.
•
In OLAP functions, the SortBy parameter can be either a metric or an attribute.
Many OLAP functions calculate measures useful for analyzing a set of values such as the sum, average, and standard deviation. These functions fall into three groups depending on how they select the window of values on which they base their calculations. These groups are as follows:
• Running
: Functions with a running window include the current value and all preceding values. For example, given the list (1, 2, 3, 4),
RunningSum returns the sums 1, 3, 6, and 10. This example is illustrated in the table below. These functions include the word Running in their name, such as RunningAvg and RunningStDev.
156
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Values
3
4
1
2
• Moving
: Functions with a moving window include the current value and a fixed number of preceding values. For example, given the list (1,2,3,4) and a window size of 2, MovingSum returns 1, 3, 5, and 7. This example is illustrated in the table below. These functions include the word Moving in their name, such as MovingAvg and MovingStDev.
• OLAP
: Functions with flexible windows allow you to set where windows begin and end in relation to the current value. This feature allows you to include both preceding and succeeding values in your calculations. For example, you can use OLAPSum to include one value above and below the current row. This example is illustrated in the table below. These functions include the word OLAP, such as OLAPSum and OLAPAvg.
The table below provides a comparison of the example scenarios described in the above section.
RunningSum
1 (1)
3 (1+2)
6 (1+2+3)
10 (1+2+3+4)
MovingSum
1 (1)
3 (1+2)
5 (2+3)
7 (3+4)
OLAPSum
3 (1+2)
6 (1+2+3)
9 (2+3+4)
7 (3+4)
ExpWghMovingAvg (exponential weighted moving average)
ExpWghMovingAvg allows you to place more or less emphasis on recent data than on past data within a specified number of rows. It is calculated within the specified window size and can restart based on an attribute specified in the function parameters.
Syntax
ExpWghMovingAvg <BreakBy, SortBy> (Argument, WindowSize,
Rate)
Where:
•
BreakBy is the attribute indicating where the calculation restarts.
•
SortBy is the attribute or metric by which the data is sorted.
•
Argument is a metric representing a list of numbers.
•
WindowSize indicates the number of values to use in each calculation.
© 2012 MicroStrategy, Inc.
OLAP functions
157
2
Standard Functions MicroStrategy Functions Reference
•
Rate is a positive real number specifying the base weight applied to each argument value. In the calculation, exponents are sequentially applied to the rate value. Assign a rate of less than one to give more emphasis to more recent data; assign a rate of greater than 1 to give greater emphasis to past data.
Expression
k
i = k m z k
=
w
i = k m w
+ 1
y i
Where:
= , ,
•
k = row number
•
y i
= metric value at the ith row
•
m = window size or the row number, whichever is smaller
•
n = number of rows
•
w = the base weight applied to each value, which is determined by the
Rate value in the function, as described in the function syntax details above
Rows with null values are excluded from the calculation.
Example
This example uses small numbers to demonstrate the calculation for the exponential weighted moving average function. For example, you have a list of values (32, 8, 5), with 5 being the most recent value, and you assign a rate of .5 and a window size of 2.
Values
32
EWM average
32
Calculation
32(.5)
0
/ (.5)
0
= 32(1)/1 = 32
8
5
16
6
8(.5)
0
+ 32(.5)
1
/ (.5)
0
+ (.5)
1
=
8(1)+ 32(.5) / 1+.5 = 8+16 / 1.5 = 16
5(.5)
0
+ 8(.5)
1
/ (.5)
0
+ (.5)
1
=
5(1)+ 8(.5) / 1+.5 = 5+4 / 1.5 = 6
158
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
As an additional example, the Human Resources Analysis Module project, which is part of the MicroStrategy Analytics Modules, includes the Division
Breakdown report shown below.
A description of how the MovingAvg metric is used on the report is provided
MovingAvg (moving average), page 172
. You can also add an exponential
weighted moving average metric to this report to apply more or less emphasis to older data. For example, you can create another derived metric named ExpWghMovingAvg with the following expression:
ExpWghMovingAvg<BreakBy={Division}, SortBy=(Quarter)>
(Employees, 4.0, 0.5)
The rate of 0.5 changes the moving average to apply more significance, or weight, to more recent data. This means that the number of Sales employees during the first quarter (13) has less weight than the number of Sales employees in the fourth quarter (18). When comparing MovingAvg and
ExpWghMovingAvg for the Sales division, you can see that the
ExpWghMovingAvg is larger. This is because more significance is given to
© 2012 MicroStrategy, Inc.
OLAP functions
159
2
Standard Functions MicroStrategy Functions Reference more recent data, and the recent trend is that employment is on the rise. This is shown in the report below.
Conversely, you can modify the same ExpWghMovingAvg metric to use the following expression:
ExpWghMovingAvg<BreakBy={Division}, SortBy= (Quarter)
>(Employees, 4.0, 2)
The rate of 2 changes the moving average to apply more significance, or weight, to older data. This means that the number of Sales employees during the first quarter (13) has more weight than the number of Sales employees in the fourth quarter (18). When comparing MovingAvg and
ExpWghMovingAvg for the Sales division, you can see that the
ExpWghMovingAvg is smaller. This is because more significance is given to
160
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2 older data, and employment was lower earlier in the year. This is shown in the report below.
ExpWghRunningAvg (exponential weighted running average)
ExpWghRunningAvg allows you compute a running average while placing more or less emphasis on recent data than on past data. The calculation can restart based on an attribute specified in the function parameters.
Syntax
ExpWghRunningAvg <BreakBy, SortBy> (Argument, Rate)
Where:
•
BreakBy is the attribute indicating where the calculation restarts.
•
SortBy is the attribute or metric by which the data is sorted.
•
Argument is a metric representing a list of numbers.
•
Rate is a positive real number specifying the base weight applied to each argument value. In the calculation, exponents are sequentially applied to the rate value. Assign a rate of less than one to give more emphasis to more recent data; assign a rate of greater than 1 to give greater emphasis to past data.
© 2012 MicroStrategy, Inc.
OLAP functions
161
2
Standard Functions MicroStrategy Functions Reference
Expression
k
w z k
=
y i
-----------------------
k = , ,
i = 1 w
Where:
•
k = row number
•
y i
= metric value at the ith row
•
m = window size or the row number, whichever is smaller
•
n = number of rows
•
w = the base weight applied to each value, which is determined by the
Rate value in the function, as described in the function syntax details above
Rows with null values are excluded from the calculation.
Example
This example uses small numbers to demonstrate the calculation for the exponential weighted running average function. For example, you have a list of values (32, 8, 5), with 5 being the most recent value, and you assign a rate of .5.
values
32
EWR average
32
calculation
32(.5)
0
/ (.5)
0
= 32(1)/1 = 32
8
5
16
10
8(.5)
0
+ 32(.5)
1
/ (.5)
0
+ (.5)
1
=
8(1)+ 32(.5) / 1+.5 = 8+16 / 1.5 = 16
5(.5)
0
+ 8(.5)
1
+ 32(.5)
2
/ (.5)
0
+ (.5)
1
+(.5)
2
= 5(1)+ 8(.5)+
32(.25) / 1+ .5 + .25 =
5 + 4 + 8 / 1.75 = 10 (rounded from 9.71)
162
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
FirstInRange
Returns the first value in a range of values. FirstInRange can be used to examine data such as inventory at the beginning of each month.
Calculations can be restarted based on attributes set in the function parameters. This restart capability differentiates FirstInRange from
First. While First is a group-value function and takes both facts and metrics as argument input, FirstInRange is an OLAP function and takes only metrics as argument input.
Syntax
FirstInRange <BreakBy, SortBy> (Argument)
Where:
•
BreakBy is the attribute indicating where the calculation restarts.
•
SortBy is the attribute or metric by which the data is sorted.
•
Argument is a metric representing a list of numbers.
Expression
z k
= y
1
k = ,
Where:
• k
= row number
• y1
= first non-NULL value of the metric after applying the BreakBy and
SortBy parameters
Example
This example shows the results of using the FirstInRange function. The report includes the attributes Customer Region and Customer State and the metrics Profit and FirstInRange. A report filter limits the regions displayed to Northwest, Southeast, and Southwest. The FirstInRange metric is defined as follows:
FirstInRange<BreakBy={[Customer Region]}, SortBy=
([Customer State]) >(Profit)
© 2012 MicroStrategy, Inc.
OLAP functions
163
2
Standard Functions MicroStrategy Functions Reference
In the following report, FirstInRange returns the first profit value in the list of Customer States for each Customer Region.
Lag
The Lag function is useful to display a set of metric values in an order determined by another metric or attribute on the report. This allows you to compare metric values side-by-side. The easiest way to understand the Lag function is with an example, provided below.
Syntax
Lag <BreakBy, SortBy> (Argument, Offset, DefaultValue)
Where:
•
BreakBy is the attribute indicating where the calculation restarts.
•
SortBy is the attribute or metric by which the data is sorted.
•
Argument is an attribute or metric representing a list of values. It is common to use a metric for Argument.
•
Offset specifies the offset from the current row to display information for. This offset trails behind the current row (you can use the Lead
function to use an offset that precedes ahead of the current row, see
). For example, with an offset of two, row three displays data for the row two behind it, which would be row one.
164
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
•
DefaultValue is the value displayed for any entries that do not have any data due to the offset. For example, when using an offset of 2, the first two entries use the default value.
It is common to enter a value of 0 or NULL for the DefaultValue.
Example
On a report with Item, Cost, and Profit, you can use the Lag function to create a Cost (Lag on Profit) metric. This metric displays Cost values based on the descending sort order of the Profit metric, and is defined with the following expression:
Lag<SortBy= (Profit Desc) >(Cost, 3.0, 0.0)
Notice that the offset is set to three, meaning that the display of cost values lags behind by three entries. This is displayed in the report results shown below.
Only the top and the bottom of the report is shown. To view the entire report results, you can create this report in the MicroStrategy Tutorial project.
© 2012 MicroStrategy, Inc.
OLAP functions
165
2
Standard Functions MicroStrategy Functions Reference
The Cost (Lag on Profit) values are displayed three behind the Cost metric, and are displayed based on the descending sort order of Profit. Notice that with an offset of three, the first three entries for Cost (Lag on Profit) use the default value of zero. Also, the last three values of Cost are not included in the Cost (Lag on Profit) metric.
The report has been sorted based on the Profit metric to make the Cost (Lag on Profit) values easier to analyze.
Transformation-style analysis using the Lag and Lead functions
Transformation-style analysis can be supported using the Lag and Lead functions provided with MicroStrategy. These functions can be used to define metrics that compare values from different time periods without the use of transformations. For information on creating transformations, see the
Project Design Guide.
Note the following:
•
The examples shown below were created in the MicroStrategy
Tutorial project.
•
The examples below use the Lag function. The Lead function can be used in the same way. The difference in using Lead rather than
Lag is that the Lead function would display information by going forward in time rather than backward. For example, while the Lag function can return historical data from one year ago, the same formula used for the Lead function would return historical data
from one year ahead.
The Lead function does not predict future values. For functions that can predict future values based on historical data, see
ForecastV (forecast, vector input), page 358
GrowthV (growth, vector input), page 363
, and
TrendV (trend, vector input), page 389
. Additionally, you can use data mining functions from
MicroStrategy Data Mining Services to predict future trends, as described in
Data mining functions, page 268
.
For example, a Last Year’s Monthly Revenue metric can be created using the following function:
Lag<SortBy=(Month@ID)>(Revenue,12,
ZeroToNull(0))
166
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
This metric can then be included on a report with the Month attribute and the Revenue metric, as shown below.
This allows you to perform a side-by-side comparison of monthly revenue for different years. In this report, the 2007 monthly revenue is displayed next to the 2008 monthly revenue. The element Jan 2009 is included to show that the Last Year’s Monthly Revenue is displaying the monthly revenue from the previous year.
By modifying the offset of the Lag function, you can change the time periods that can be compared side by side. For example, the function listed above uses an offset of 12, which displays monthly data from one year ago. Using an offset of 3 would display monthly data from three months ago, while using an offset of 24 would display monthly data from two years ago. These slight modifications could be used to create separate metrics that could all be included on the same report. The report below shows an example of
© 2012 MicroStrategy, Inc.
OLAP functions
167
2
Standard Functions MicroStrategy Functions Reference including three different metrics that use the same Lag formula with a different offset.
The report shown above allows side-by-side comparison of monthly revenue for three different time periods. In this report, the Monthly Revenue 2 Years
Ago metric displays no data for months in the year 2008 because no revenue data exists for the year 2006.
To use the Lag or Lead functions for transformation-style analysis, the metric formulas must be created to support the required reporting scenario.
For example, the report with the Month attribute and the Revenue metric has the Category attribute added to it. To support this reporting scenario, you can modify the Lag formula described above to include the Category attribute, as shown below.
Lag<BreakBy={Category},SortBy=(Month@ID)>
(Revenue,12,ZeroToNull(0))
168
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Using the formula shown above, the calculation is restarted for each category, which allows the side-by-side comparison of monthly revenue over time for each category, as shown in the report below:
Only the Month attribute elements Jan 2007, Jan 2008, and Jan 2009 are displayed to show that the Last Year’s Monthly Revenue (Category) metric is displaying the monthly revenue from the previous year.
LastInRange
Returns the last value in a range of values. LastInRange can be used to examine data such as inventory at the end of each month.
Calculations can be restarted based on attributes set in the function parameters. This restart capability differentiates LastInRange from Last.
While Last is a group-value function and takes both facts and metrics as argument input, LastInRange is an OLAP function and takes only metrics as argument input.
Syntax
LastInRange <BreakBy={}, SortBy=()> (Argument)
Where:
•
BreakBy is the attribute indicating where the calculation restarts.
•
SortBy is the attribute or metric by which the data is sorted.
© 2012 MicroStrategy, Inc.
OLAP functions
169
2
Standard Functions MicroStrategy Functions Reference
•
Argument is a metric representing a list of numbers.
Expression
z k
= y k
k = ,
Where:
• k
= row number
• yk
= last non-NULL value of the metric after applying the BreakBy and
SortBy parameters
Lead
The Lead function is useful to display a set of metric values in an order determined by another metric or attribute on the report. This allows you to compare metric values side-by-side. The easiest way to understand the Lead function is with an example, provided below.
Syntax
Lead <BreakBy, SortBy> (Argument, Offset, DefaultValue)
Where:
•
BreakBy is the attribute indicating where the calculation restarts.
•
SortBy is the attribute or metric by which the data is sorted.
•
Argument is an attribute or metric representing a list of values. It is common to use a metric for Argument.
•
Offset specifies the offset from the current row to display information for. This offset precedes ahead of the current row (you can use the Lag function to use an offset that trails behind the current row, see
). For example, with an offset of two, row one displays data for the row two ahead of it, which would be row three.
•
DefaultValue is the value displayed for any entries that do not have any data due to the offset. For example, when using an offset of 2, the last two entries use the default value.
It is common to enter a value of 0 or NULL for the DefaultValue.
Example
170
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
For an example of using Lag and Lead functions to perform
transformation-style analysis, see
Transformation-style analysis using the
Lag and Lead functions, page 166
.
On a report with Item, Cost, and Profit, you can use the Lag function to create a Cost (Lead on Profit) metric. This metric displays Cost values based on the descending sort order of the Profit metric, and is defined with the following expression:
Lead<SortBy= (Profit Desc) >(Cost, 3.0, 0.0)
Notice that the offset is set to three, meaning that the display of cost values is displayed three ahead of the current value. This is displayed in the report results shown below.
Only the top and the bottom of the report is shown. To view the entire report results, you can create this report in the MicroStrategy Tutorial project.
The Cost (Lead on Profit) values are displayed three ahead of the Cost metric, and are displayed based on the descending sort order of Profit. Notice that with an offset of three, the last three entries for Cost (Lead on Profit) use the
© 2012 MicroStrategy, Inc.
OLAP functions
171
2
Standard Functions MicroStrategy Functions Reference default value of zero. Also, the first three values of Cost are not included in the Cost (Lead on Profit) metric.
The report has been sorted based on the Profit metric to make the Cost (Lead on Profit) values easier to analyze.
MovingAvg (moving average)
Returns the moving average of the current value and preceding values, as defined by the WindowSize parameter. The calculations can be restarted based on attributes set in the function parameters. This is an OLAP function.
Syntax
MovingAvg <BreakBy={}, SortBy=()> (Argument, WindowSize)
Where:
•
BreakBy is the attribute indicating where the calculation restarts.
•
SortBy is the attribute or metric by which the data is sorted.
•
Argument is a metric representing a list of numbers.
•
WindowSize is a positive integer indicating the number of values to use in each calculation.
Expression
z k
= m k
y i i = k m + 1
k = , ,
Where:
• yi
= metric value at the i th
row
•
m = window size
•
n = number of rows/metric values
Example
This simple example illustrates how the MovingAvg function calculates a list of values and returns the average of a specified number of values. In this
172
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2 case, the window size is set to 3, meaning that the value in the Moving
Average column represents the average of the current value of the two values that precede it in the value list. The calculation is shown in the following table.
Values
5
20
40
10
20
30
15
Moving Average
10 (10/1)
15 ((20+10) / 2)
20 ((30+20+10) / 3)
51.67 ((15+30+20) / 3)
16.67 ((5+15+30) / 3)
13.34 ((20+5+15) / 3)
21.67 ((40+20+5) / 3)
As an additional example, the Human Resources Analysis Module project, which is part of the Analytics Modules, includes the Division Breakdown report shown below.
© 2012 MicroStrategy, Inc.
OLAP functions
173
2
Standard Functions MicroStrategy Functions Reference
This report displays details about employee headcounts for each division, over the various quarters of 2010. Included in this report is the metric
MovingAvg. It is defined as a derived metric, using the following expression:
MovingAvg<BreakBy={Division}, SortBy=(Quarter)>
(Employees, 4.0)
This expression calculates the moving average of employee headcount for a given division, during the four quarters of 2010. The window size of 4.0 specifies that the average is calculated across the four quarters, and
BreakBy={Divison} ensures that the moving average calculation is specific to each division.
Using this MovingAvg metric, you can determine that the Sales division had between 13.0 and 16.3 employees on average during the 2010 year, with slight increases throughout the year.
For an extension of this example on how you can also use a weighted moving
ExpWghMovingAvg (exponential weighted moving average), page 157
MovingCount
Returns the moving count of a list of values. The calculation can be restarted based on attributes set in the function parameters. This is an OLAP function.
Syntax
MovingCount <BreakBy={}, SortBy=()> (Argument,
WindowSize)
Where:
•
BreakBy is the attribute indicating where the calculation restarts.
•
SortBy is the attribute or metric by which the data is sorted.
•
Argument is a metric representing a list of values.
•
WindowSize is a positive integer indicating the highest number to use in the count.
174
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Expression
z k
= k
y i i = k m + 1
k
=
,
Where:
• yi
= metric value at the i th
row
•
m
= window size
•
n
= number of rows/metric values
•
1 i
1 i
= 1 if the value at the i
= 0 otherwise th
row is not NULL
Usage Notes
If there are more entries in a section than the integer in the window size parameter, then all the remaining entries are given the highest number in the count. For example, if the window size is 4 and there are 6 entries in the list section, they are counted as follows: 1,2,3,4,4,4.
Example
This simple example demonstrates how the MovingCount function counts rows of data. This report uses the attributes Region and Employee, and the metrics Revenue and Moving Count. A filter is applied so the only Regions displayed are South, Northwest, and Southwest. The Moving Count metric is defined as follows:
MovingCount<BreakBy={Region}, SortBy= (Value) >(Revenue,
3.0)
•
The count restarts for every Region.
•
The entries are counted based on the value of the metric Revenue in ascending order (the lowest value is counted as 1, next lowest is 2, and so on).
© 2012 MicroStrategy, Inc.
OLAP functions
175
2
Standard Functions MicroStrategy Functions Reference
•
The highest number in the count is 3 as designated in the WindowSize parameter.
MovingDifference
Returns the moving difference between current and preceding values. The position of the preceding row used in the calculation is defined in the function arguments. The calculations can be restarted based on attributes set in the function parameters. This is an OLAP function.
Syntax
MovingDifference <BreakBy, SortBy> (Argument,
WindowSize)
Where:
•
BreakBy is the attribute indicating where the calculation restarts.
•
SortBy is the attribute or metric by which the data is sorted.
•
Argument is a metric representing a list of numbers.
•
WindowSize is a positive integer indicating the range of values used to compute each difference.
Expression
z k
= y k
– y
+ 1
k
=
,
176
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Where:
• yi
= metric value at the i th
row
•
m
= window size
•
n
= number of rows/metric values
Example
This example illustrates how the Moving Difference function subtracts the value of a preceding row from the value of the current row and returns the difference. In this case, the window size is set to 3, meaning that the value two rows previous to the current row is subtracted from the current row. In other words, there are 3 rows in the window, the current row is 1, the row immediately preceding it is 2, and the row preceding that is 3; therefore, the calculations is row3-row1.
The value in the Moving Difference column represents the result of the calculation for every window of three values. The calculation is also shown.
Values
400
500
700
300
600
800
200
Moving Difference
300 (700-400)
-200 (300-500)
-100 (600-700)
500 (800-300)
-400 (200-600)
MovingMax (moving maximum)
Returns the moving maximum value by comparing current and preceding rows as defined in the function arguments. The calculation can be restarted based on attributes set in the function parameters. This is an OLAP function.
Syntax
MovingMax <BreakBy, SortBy> (Argument, WindowSize)
© 2012 MicroStrategy, Inc.
OLAP functions
177
2
Standard Functions MicroStrategy Functions Reference
Where:
•
BreakBy is the attribute indicating where the calculation restarts.
•
SortBy is the attribute or metric by which the data is sorted.
•
Argument is a metric representing a list of numbers.
•
WindowSize is a positive integer indicating the number of values to compare in each calculation.
Expression
z k
= max i = k m +
y i
1 k
k = ,
Where:
• yi
= metric value at the i th
row
•
m = window size
•
n = number of rows/metric values
Example
This simple example illustrates how the Moving Maximum function moves through a list of values, subtracting a value from the user-defined number of preceding rows. In this case, the window size is set to 3, meaning that the value in the Moving Maximum column represents the highest value among the current and preceding two values in the value list. The calculation is shown in the following table.
Values
550
30
40
70
50
Moving Maximum
550
550 (550>30)
550 (550>40 and 550>30)
70 (70>40and 70>30)
70 (70>50 and 70>40)
MovingMin (moving minimum)
Compares the current value and preceding values as defined in the function arguments to calculate a moving minimum value. The calculation can be
178
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2 restarted based on attributes set in the function parameters. This is an OLAP function.
Syntax
MovingMin <BreakBy,SortBy>(Argument, WindowSize)
Where:
•
BreakBy is the attribute indicating where the calculation restarts.
•
SortBy is the attribute or metric by which the data is sorted.
•
Argument is a metric representing a list of numbers.
•
WindowSize is a positive integer indicating the number of values to use in each calculation.
Expression
z k
= min i = k m +
y
, i
1 k
k = , ,
Where:
• yi
= metric value at the i th
row
•
m = window size
•
n = number of rows/metric values
Example
This simple example illustrates how the Moving Minimum function moves through a list of values returning the lowest value within a specified number of values. In this case, the window size is set to 3, meaning that the value in the Moving Minimum column represents the lowest value among the current and preceding two values in the value list. The calculation is shown in the following table.
Values
550
30
40
70
50
Moving Minimum
550
30 (30<550)
30 (30<40 and 30<550)
30 (30<70 and 30<40)
40 (40<70 and 40<50)
© 2012 MicroStrategy, Inc.
OLAP functions
179
2
Standard Functions MicroStrategy Functions Reference
MovingStDevP (moving standard deviation of a population)
Returns the moving standard deviation of a population based on a list of values that encompasses the whole population. The calculation can be restarted based on attributes set in the function parameters. This is an OLAP function.
Syntax
MovingStDevP <BreakBy, SortBy> (Argument, WindowSize)
Where:
•
BreakBy is the attribute indicating where the calculation restarts.
•
SortBy is the attribute or metric by which the data is sorted.
•
Argument is a metric representing a list of numbers.
•
WindowSize is a positive integer indicating the number of values to use in each calculation.
Expression
z k
= k
i = k m
y i
– y
2 m
k = , ,
Where:
• yi
= metric value at the i th
row
•
y = average of metric
•
m = window size
•
n = number of rows/metric values
Example
This example shows a report where the moving standard deviation of the revenue is calculated. This calculation is based on the assumption that the list of values supplied in the metric represents the entire population of the data for which you want to obtain the standard deviation. The calculation starts over for each region, the information is sorted within the region by
180
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2 state in ascending order, and each calculation is based upon a window size of
3.
Compare this example report to the example for MovingStDev to see the different values returned when calculating for a population as opposed to a sample.
The report contains the attributes Customer Region and Customer State, and the metrics Total Revenue, MovingStDevP, Running StDevP, and StDevP. A report filter limits data to the South, Southwest, and Northwest regions. The definition of the MovingStDevP metric is as follows:
MovingStDevP<BreakBy={[Customer Region]}, SortBy=
<[Customer State])>([Total Revenue],3)
MovingStDev (moving standard deviation)
Returns the moving standard deviation based on a list of values that is a sample of the population. The calculation can be restarted based on attributes set in the function parameters. This is an OLAP function.
Syntax
MovingStDev <BreakBy, SortBy> (Argument, WindowSize)
© 2012 MicroStrategy, Inc.
OLAP functions
181
2
Standard Functions MicroStrategy Functions Reference
Where:
•
BreakBy is the attribute indicating where the calculation restarts.
•
SortBy is the attribute or metric by which the data is sorted.
•
Argument is a metric representing a list of number.
•
WindowSize is a positive integer indicating the number of values to use in each calculation.
Expression
z k
= k
y i
– y
2
----------------------------
k = , ,
Where:
• yi
= metric value at the i th
row
•
y = average of metric
•
m = window size
•
n = number of rows/metric values
Example
This example shows a report where the moving standard deviation of the revenue is calculated. This calculation is based on the assumption that the list of values supplied in the metric represents a sample of the data for which you want to obtain the standard deviation. The calculation starts over for each region, the information is sorted within the region by state in ascending order, and each calculation is based upon a window size of 3.
Compare this example report to the example for MovingStDevP to see the different values returned when calculating for a population as opposed to a sample.
The report contains the attributes Customer Region and Customer State, and the metrics Total Revenue, MovingStDev, Running StDev, and StDev. A report filter limits data to the Southwest, Southeast, and Northwest regions.
The definition of the Moving StDev metric is as follows:
182
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
MovingStDev<BreakBy={[Customer Region]}, SortBy=
<[Customer State])>([Total Revenue], 3)
MovingSum
Returns the moving sum of the current value and preceding values as defined in the function arguments. The calculations can be restarted based on attributes set in the function parameters. This is an OLAP function.
Syntax
MovingSum <BreakBy,SortBy>(Argument, WindowSize)
Where:
•
Argument is a metric representing a list of numbers.
•
BreakBy is the attribute indicating where the calculation restarts.
•
SortBy is the attribute or metric by which the data is sorted.
•
WindowSize a positive integer indicating the number of values to sum in each calculation.
© 2012 MicroStrategy, Inc.
OLAP functions
183
2
Standard Functions MicroStrategy Functions Reference
Expression
z k
= k
i = k m y i
+ 1
k = ,
Where:
• yi
= metric value at the i th
row
•
m = window size
•
n = number of rows/metric values
Example
This simple example illustrates how the MovingSum function moves through a list of values calculating and returning the sum of a specified number of values. In this case the window size is set to 2 meaning that the sum in the
Moving Sum column represents the current value added to the value from the value list that precedes it. The calculation is shown in the following table.
Values
10
20
30
15
5
Moving Sum
10
30 (20+10)
50 (30+20)
45 (15+30)
20 (5+15)
OLAPAvg (OLAP average)
Returns the average of the current value, preceding values, and succeeding values as defined in the function arguments. Unlike RunningAvg and
MovingAvg, which can only include values above the current row in the calculation, you can use OLAPAvg to include values both above and below the current row in the calculation.
The calculations can be restarted based on attributes defined in the function parameters.
184
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Syntax
OLAPAvg<Distinct, OLAPWinStType, OLAPWinStOffset,
OLAPWinEndType, OLAPWinEndOffset, BreakBy,
SortBy>(Argument)
Where:
•
Distinct is a TRUE/FALSE parameter that allows you to use all values in the calculation or to calculate using only the unique values. If you define Distinct to be true, then the parameters OLAPWinStType,
OLAPWinStOffset, OLAPWinEndType, OLAPWinEndOffset, and
SortBy are ignored.
•
BreakBy is the attribute indicating where the calculation restarts.
•
SortBy is the attribute or metric by which the data is sorted.
•
OLAPWinStType defines the window type for the starting location of the calculation. Select one of the following options, listed by the name of the setting and its corresponding OLAPWinStType value in parentheses:
Top of data set (0): The calculation starts at the top value as determined by the BreakBy and SortBy values.
Current row (2): The calculation starts at the current row.
N rows before current row (3): The calculation starts a number of rows before the current row. You define this offset of rows with the
OLAPWinStOffset parameter described below.
N rows after current row (4): The calculation starts a number of rows after the current row. You define this offset of rows with the
OLAPWinStOffset parameter described below.
•
OLAPWinStOffset defines the offset of rows from the current row to start the calculation. You can define this offset if the OLAPWinStType parameter is defined as N rows before current row (3) or N rows after current row (4).
•
OLAPWinEndType defines the window type for the ending location of the calculation. Select one of the following options, listed by the name of the setting and its corresponding OLAPWinEndType value in parentheses:
Bottom of data set (1): The calculation stops at the bottom value. The top value is determined by the BreakBy and SortBy values.
Current row (2): The calculation stops at the current row.
© 2012 MicroStrategy, Inc.
OLAP functions
185
2
Standard Functions MicroStrategy Functions Reference
N rows before current row (3): The calculation stops a number of rows before the current row. You define this offset of rows with the
OLAPWinEndOffset parameter described below.
N rows after current row (4): The calculation stops a number of rows after the current row. You define this offset of rows with the
OLAPWinEndOffset parameter described below.
•
OLAPWinEndOffset defines the offset of rows from the current row to stop the calculation. You can define this offset if the OLAPWinEndType parameter is defined as N rows before current row (3) or N rows after current row (4).
•
Argument is a metric representing a list of numbers.
The function is not valid if your starting point is at a lower point than your ending point.
Example
An OLAPAvg Unit Cost metric is created using the OLAPAvg function based on the Unit Cost metric, as defined below:
OLAPAvg<OLAPWinStType=3, OLAPWinStOffset=3,
OLAPWinEndType=4, OLAPWinEndOffset=2, BreakBy={Category}
SortBy={Item}>([Unit Cost])
The starting point for the average is defined as three rows before the current row (OLAPWinStType=3, OLAPWinStOffset=3). The stopping point for the average is defined as two rows after the current row (OLAPWinEndType=
4, OLAPWinEndOffset=2).
186
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
This metric is displayed on a report along with Category, Item, and Unit
Cost, as shown below.
There are a few facts about this data to take note of.
The first value of OLAPAvg Unit Cost is $15. This is calculated by adding $32,
$8, and $5 to get a total of $45. This total of $45 is then divided by three (the number of rows included in the calculation) to get the final result of $15.
These rows are included because the calculation ends two rows after the current row. Even though the calculation starts three rows before the current row, there is no data above the current row to include in the calculation.
The fourth value for OLAPAvg Unit Cost is the first value that can include data from all three rows above the current row to two rows below the current row in the calculation (($32 + $8 + $5 + $25 + $19 + $20) / 6 =
$18.17). Notice that with this calculation a value of six is used to calculate the average because six rows were included in the average.
While it is not shown on this report, the calculation would restart for the first
Item of the next Category because the function is defined to break by the
Category attribute.
OLAPCount
Returns the count of the current value, preceding values, and succeeding values as defined in the function arguments. Unlike RunningCount and
© 2012 MicroStrategy, Inc.
OLAP functions
187
2
Standard Functions MicroStrategy Functions Reference
MovingCount, which can only include values above the current row in the calculation, you can use OLAPCount to include values both above and below the current row in the calculation.
The calculations can be restarted based on attributes defined in the function parameters.
Syntax
OLAPCount<Distinct, Null, OLAPWinStType,
OLAPWinStOffset, OLAPWinEndType, OLAPWinEndOffset,
BreakBy, SortBy>(Argument)
Where:
•
Distinct is a TRUE/FALSE parameter that allows you to use all values in the calculation or to calculate using only the unique values. If you define Distinct to be true, then the parameters Null,
OLAPWinStType, OLAPWinStOffset, OLAPWinEndType,
OLAPWinEndOffset, and SortBy are ignored.
•
Null is a TRUE/FALSE parameter that defines whether null values are included in the total count.
•
BreakBy is the attribute indicating where the calculation restarts.
•
SortBy is the attribute or metric by which the data is sorted.
•
OLAPWinStType defines the window type for the starting location of the calculation. Select one of the following options, listed by the name of the setting and its corresponding OLAPWinStType value in parentheses:
Top of data set (0): The calculation starts at the top value as determined by the BreakBy and SortBy values.
Current row (2): The calculation starts at the current row.
N rows before current row (3): The calculation starts a number of rows before the current row. You define this offset of rows with the
OLAPWinStOffset parameter described below.
N rows after current row (4): The calculation starts a number of rows after the current row. You define this offset of rows with the
OLAPWinStOffset parameter described below.
•
OLAPWinStOffset defines the offset of rows from the current row to start the calculation. You can define this offset if the OLAPWinStType parameter is defined as N rows before current row (3) or N rows after current row (4).
188
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
•
OLAPWinEndType defines the window type for the ending location of the calculation.Select one of the following options, listed by the name of the setting and its corresponding OLAPWinEndType value in parentheses:
Bottom of data set (1): The calculation stops at the bottom value. The top value is determined by the BreakBy and SortBy values.
Current row (2): The calculation stops at the current row.
N rows before current row (3): The calculation starts a number of rows before the current row. You define this offset of rows with the
OLAPWinEndOffset parameter described below.
N rows after current row (4): The calculation starts a number of rows after the current row. You define this offset of rows with the
OLAPWinEndOffset parameter described below.
•
OLAPWinEndOffset defines the offset of rows from the current row to stop the calculation. You can define this offset if the OLAPWinEndType parameter is defined as N rows before current row (3) or N rows after current row (4).
•
Argument is a metric representing a list of numbers.
The function is not valid if your starting point is at a lower point than your ending point.
Example
An OLAPCount Unit Cost metric is created using the OLAPCount function based on the Unit Cost metric, as defined below:
OLAPCount<OLAPWinStType=3, OLAPWinStOffset=3,
OLAPWinEndType=4, OLAPWinEndOffset=2, BreakBy={Category}
SortBy={Subcategory}>([Unit Cost])
The starting point for the count is defined as three rows before the current row (OLAPWinStType=3, OLAPWinStOffset=3). The stopping point for the summation is defined as two rows after the current row
(OLAPWinEndType=4, OLAPWinEndOffset=2).
OLAP functions
189
© 2012 MicroStrategy, Inc.
2
Standard Functions MicroStrategy Functions Reference
This metric is displayed on a report along with Category, Subcategory, and
Unit Cost, as shown below.
There are a few facts about this data to take note of.
The first value of OLAPCount Unit Cost is three. This is calculated by counting the current row and two rows after the current row. Even though the calculation starts three rows before the current row, there is no data above the current row to include in the calculation.
The fourth entry for OLAPCount Unit Cost is the first entry that can count all three rows above the current row to two rows below the current row in the calculation. This entry is able to reach the maximum value of six. Notice that after this entry the count begins to decrease because there are no longer two rows below the current row to include in the calculation.
The calculation restarts for the first Subcategory of the next Category because the function is defined to break by the Category attribute.
190
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
OLAPMax (OLAP maximum)
Returns the maximum value based on comparing the current value, preceding values, and succeeding values as defined in the function arguments. Unlike RunningMax and MovingMax, which can only include values above the current row in the calculation, you can use OLAPMax to include values both above and below the current row in the calculation.
The calculations can be restarted based on attributes defined in the function parameters.
Syntax
OLAPMax<OLAPWinStType, OLAPWinStOffset, OLAPWinEndType,
OLAPWinEndOffset, BreakBy, SortBy>(Argument)
Where:
•
BreakBy is the attribute indicating where the calculation restarts.
•
SortBy is the attribute or metric by which the data is sorted.
•
OLAPWinStType defines the window type for the starting location of the calculation. Select one of the following options, listed by the name of the setting and its corresponding OLAPWinStType value in parentheses:
Top of data set (0): The calculation starts at the top value as determined by the BreakBy and SortBy values.
Current row (2): The calculation starts at the current row.
N rows before current row (3): The calculation starts a number of rows before the current row. You define this offset of rows with the
OLAPWinStOffset parameter described below.
N rows after current row (4): The calculation starts a number of rows after the current row. You define this offset of rows with the
OLAPWinStOffset parameter described below.
•
OLAPWinStOffset defines the offset of rows from the current row to start the calculation. You can define this offset if the OLAPWinStType parameter is defined as N rows before current row (3) or N rows after current row (4).
© 2012 MicroStrategy, Inc.
OLAP functions
191
2
Standard Functions MicroStrategy Functions Reference
•
OLAPWinEndType defines the window type for the ending location of the calculation. Select one of the following options, listed by the name of the setting and its corresponding OLAPWinEndType value in parentheses:
Bottom of data set (1): The calculation stops at the bottom value. The top value is determined by the BreakBy and SortBy values.
Current row (2): The calculation stops at the current row.
N rows before current row (3): The calculation starts a number of rows before the current row. You define this offset of rows with the
OLAPWinEndOffset parameter described below.
N rows after current row (4): The calculation starts a number of rows after the current row. You define this offset of rows with the
OLAPWinEndOffset parameter described below.
•
OLAPWinEndOffset defines the offset of rows from the current row to stop the calculation. You can define this offset if the OLAPWinEndType parameter is defined as N rows before current row (3) or N rows after current row (4).
•
Argument is a metric representing a list of numbers.
The function is not valid if your starting point is at a lower point than your ending point.
Example
An OLAPMax Unit Cost metric is created using the OLAPMax function based on the Unit Cost metric, as defined below:
OLAPMax<OLAPWinStType=3, OLAPWinStOffset=3,
OLAPWinEndType=4, OLAPWinEndOffset=2, BreakBy={Category}
SortBy={Subcategory}>([Unit Cost])
The starting point for the calculation is defined as three rows before the current row (OLAPWinStType=3, OLAPWinStOffset=3). The stopping point for the calculation is defined as two rows after the current row
(OLAPWinEndType=4, OLAPWinEndOffset=2).
192
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
This metric is displayed on a report along with Category, Subcategory, and
Unit Cost, as shown below.
There are a few facts about this data to take note of.
The first value of OLAPMax Unit Cost is $14. This is calculated by returning the maximum value of $14, $11, and $6. These are included because the calculation ends two rows after the current row. Even though the calculation starts three rows before the current row, there is no data above the current row to include in the calculation.
The second value also returns $14 as it returns the maximum value of $14,
$11, $6, and $7.
The third value for OLAPMax Unit Cost is the first entry that includes $26 in its maximum calculation. The rest of the OLAPMax Unit Cost values for the
Books Category return $26 because this is the maximum value, and it is within the window of three rows above the current row to two rows below the current row.
© 2012 MicroStrategy, Inc.
OLAP functions
193
2
Standard Functions MicroStrategy Functions Reference
The calculation restarts for the first Subcategory of the next Category because the function is defined to break by the Category attribute.
OLAPMin (OLAP minimum)
Returns the minimum value based on comparing the current value, preceding values, and succeeding values as defined in the function arguments. Unlike RunningMin and MovingMin, which can only include values above the current row in the calculation, you can use OLAPMin to include values both above and below the current row in the calculation.
The calculations can be restarted based on attributes defined in the function parameters.
Syntax
OLAPMin<OLAPWinStType, OLAPWinStOffset, OLAPWinEndType,
OLAPWinEndOffset, BreakBy, SortBy>(Argument)
Where:
•
BreakBy is the attribute indicating where the calculation restarts.
•
SortBy is the attribute or metric by which the data is sorted.
•
OLAPWinStType defines the window type for the starting location of the calculation. Select one of the following options, listed by the name of the setting and its corresponding OLAPWinStType value in parentheses:
Top of data set (0): The calculation starts at the top value as determined by the BreakBy and SortBy values.
Current row (2): The calculation starts at the current row.
N rows before current row (3): The calculation starts a number of rows before the current row. You define this offset of rows with the
OLAPWinStOffset parameter described below.
N rows after current row (4): The calculation starts a number of rows after the current row. You define this offset of rows with the
OLAPWinStOffset parameter described below.
•
OLAPWinStOffset defines the offset of rows from the current row to start the calculation. You can define this offset if the OLAPWinStType parameter is defined as N rows before current row (3) or N rows after current row (4).
194
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
•
OLAPWinEndType defines the window type for the ending location of the calculation. Select one of the following options, listed by the name of the setting and its corresponding OLAPWinEndType value in parentheses:
Bottom of data set (1): The calculation stops at the bottom value. The top value is determined by the BreakBy and SortBy values.
Current row (2): The calculation stops at the current row.
N rows before current row (3): The calculation starts a number of rows before the current row. You define this offset of rows with the
OLAPWinEndOffset parameter described below.
N rows after current row (4): The calculation starts a number of rows after the current row. You define this offset of rows with the
OLAPWinEndOffset parameter described below.
•
OLAPWinEndOffset defines the offset of rows from the current row to stop the calculation. You can define this offset if the OLAPWinEndType parameter is defined as N rows before current row (3) or N rows after current row (4).
•
Argument is a metric representing a list of numbers.
The function is not valid if your starting point is at a lower point than your ending point.
Example
An OLAPMin Unit Cost metric is created using the OLAPMin function based on the Unit Cost metric, as defined below:
OLAPMin<OLAPWinStType=3, OLAPWinStOffset=3,
OLAPWinEndType=4, OLAPWinEndOffset=2, BreakBy={Category}
SortBy={Subcategory}>([Unit Cost])
The starting point for the calculation is defined as three rows before the current row (OLAPWinStType=3, OLAPWinStOffset=3). The stopping point for the calculation is defined as two rows after the current row
(OLAPWinEndType=4, OLAPWinEndOffset=2).
OLAP functions
195
© 2012 MicroStrategy, Inc.
2
Standard Functions MicroStrategy Functions Reference
This metric is displayed on a report along with Category, Subcategory, and
Unit Cost, as shown below.
There are a few facts about this data to take note of.
The first value of OLAPMinUnit Cost is $6. This is calculated by returning the minimum value of $14, $11, and $6. These are included because the calculation ends two rows after the current row. Even though the calculation starts three rows before the current row, there is no data above the current row to include in the calculation.
All of the OLAPMin Unit Cost values for the Books Category return $6 because this is the minimum value, and it is within the window of three rows above the current row to two rows below the current row.
The calculation restarts for the first Subcategory of the next Category because the function is defined to break by the Category attribute.
196
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
OLAPRank
Returns the rank of the current value based on the other values defined by the sorting criteria. The ranking can be restarted based on attributes defined in the function parameters.
The OLAPRank function allows the ranking to be calculated in the database, rather calculating the ranking using the MicroStrategy Analytical Engine.
Be aware of the following:
•
Since OLAPRank is calculated in the database, you can only use this function if your database supports the OLAPRank function.
•
Any metrics that use the OLAPRank function must not be defined as smart metrics. If metrics that use OLAPRank are defined as smart metrics, the calculation is performed in the MicroStrategy
Analytical Engine and an error is returned.
•
You must include at least one metric in the SortBy parameter.
Syntax
OLAPRank<BreakBy, SortBy>()
Where:
•
BreakBy is the attribute indicating where the ranking restarts.
•
SortBy is the attribute or metric by which the data is sorted. For
OLAPRank, the SortBy parameter is also where you can include the metric to perform the calculation on. You must include at least one metric in the SortBy parameter.
Example
The MicroStrategy Tutorial project includes an Avg Revenue per Customer metric. This metric can be placed on a report along with the attributes
Quarter and Region to display the quarterly average revenue per customer for each region.
To extend this analysis, you can create an OLAPRank Avg Rev per Customer metric as defined below:
OLAPRank<BreakBy={Quarter}, SortBy= ([Avg Revenue per Customer],
Region@ID) >()
OLAP functions
197
© 2012 MicroStrategy, Inc.
2
Standard Functions MicroStrategy Functions Reference
When this metric is included on a report with Quarter, Region, and Avg
Revenue per Customer, it displays the regional rank of the quarterly average revenue per customer for each region. This is shown in the report below.
The report has been sorted by Quarter, and then by the OLAPRank
Avg Rev per Customer values.
The report shown above displays regions based on their average revenue per customer for each quarter, sorted from the lowest average revenue per customer to the highest. This analysis allows you to quickly see how regions are performing based on average revenue per customer over different quarters. In the first three quarters of data shown above, Web has the lowest average revenue per customer. However, their is some variation in the performance of the other regions. Performing this analysis over extended periods of time can help to show trends in revenue and regional performance.
198
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
OLAPSum
Returns the summation of the current value, preceding values, and succeeding values as defined in the function arguments. Unlike
RunningSum and MovingSum, which can only include values above the current row in the calculation, you can use OLAPSum to include values both above and below the current row in the calculation.
The calculations can be restarted based on attributes defined in the function parameters.
Syntax
OLAPSum<Distinct, OLAPWinStType, OLAPWinStOffset,
OLAPWinEndType, OLAPWinEndOffset, BreakBy,
SortBy>(Argument)
Where:
•
Distinct is a TRUE/FALSE parameter that allows you to use all values in the calculation or to calculate using only the unique values. If you define Distinct to be true, then the parameters OLAPWinStType,
OLAPWinStOffset, OLAPWinEndType, OLAPWinEndOffset, and
SortBy are ignored.
•
BreakBy is the attribute indicating where the calculation restarts.
•
SortBy is the attribute or metric by which the data is sorted.
•
OLAPWinStType defines the window type for the starting location of the calculation. Select one of the following options, listed by the name of the setting and its corresponding OLAPWinStType value in parentheses:
Top of data set (0): The calculation starts at the top value as determined by the BreakBy and SortBy values.
Current row (2): The calculation starts at the current row.
N rows before current row (3): The calculation starts a number of rows before the current row. You define this offset of rows with the
OLAPWinStOffset parameter described below.
N rows after current row (4): The calculation starts a number of rows after the current row. You define this offset of rows with the
OLAPWinStOffset parameter described below.
•
OLAPWinStOffset defines the offset of rows from the current row to start the calculation. You can define this offset if the OLAPWinStType
© 2012 MicroStrategy, Inc.
OLAP functions
199
2
Standard Functions MicroStrategy Functions Reference parameter is defined as N rows before current row (3) or N rows after current row (4).
•
OLAPWinEndType defines the window type for the ending location of the calculation. Select one of the following options, listed by the name of the setting and its corresponding OLAPWinEndType value in parentheses:
Bottom of data set (1): The calculation stops at the bottom value. The top value is determined by the BreakBy and SortBy values.
Current row (2): The calculation stops at the current row.
N rows before current row (3): The calculation stops a number of rows before the current row. You define this offset of rows with the
OLAPWinEndOffset parameter described below.
N rows after current row (4): The calculation stops a number of rows after the current row. You define this offset of rows with the
OLAPWinEndOffset parameter described below.
•
OLAPWinEndOffset defines the offset of rows from the current row to stop the calculation. You can define this offset if the OLAPWinEndType parameter is defined as N rows before current row (3) or N rows after current row (4).
•
Argument is a metric representing a list of numbers.
The function is not valid if your starting point is at a lower point than your ending point.
Example
An OLAPSum Unit Cost metric is created using the OLAPSum function based on the Unit Cost metric, as defined below:
OLAPSum<OLAPWinStType=3, OLAPWinStOffset=3,
OLAPWinEndType=4, OLAPWinEndOffset=2, BreakBy={Category}
SortBy={Subcategory}>([Unit Cost])
The starting point for the summation is defined as three rows before the current row (OLAPWinStType=3, OLAPWinStOffset=3). The stopping point for the summation is defined as two rows after the current row
(OLAPWinEndType=4, OLAPWinEndOffset=2).
200
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
This metric is displayed on a report along with Category, Subcategory, and
Unit Cost, as shown below.
There are a few facts about this data to take note of.
The first value of OLAPSum Unit Cost is $30.82. This is calculated by adding
$13.93, $10.75, and $6.13. These are included because the calculation ends two rows after the current row. Even though the calculation starts three rows before the current row, there is no data above the current row to include in the calculation.
The data displayed on the report is rounded to the nearest cent, which can give the impression that some calculations are slightly incorrect.
For example, adding $13.93, $10.75, and $6.13 actually totals $30.81 rather than $30.82 as displayed on the report. This difference is because the data is rounded up for display on the report. You can display more decimal values for the Unit Cost and OLAPSum Unit
Cost metrics to see the exact values.
The fourth value for OLAPSum Unit Cost is the only value that can include data from all three rows above the current row to two rows below the current
OLAP functions
201
© 2012 MicroStrategy, Inc.
2
Standard Functions MicroStrategy Functions Reference row in the calculation ($13.93 + $10.75 + $6.13 + $7.20 + $25.93
+ $9.43 = $73.38).
The final OLAPSum Unit Cost value for the Books Category can only include the Unit Cost value for the current row and the three rows above it ($6.13 +
$7.20 + $25.93 + $9.43 = $48.70). It cannot include two rows below the current row because the calculation restarts for the first Subcategory of the next Category. The calculation restarts because the function is defined to break by the Category attribute.
RunningAvg (running average)
Moves through the values in a list and returns the running average, adding the current value to the sum of the preceding values and dividing by the current count of values. The calculation can restart based on attribute groupings identified in the parameter settings. This is an OLAP function.
Syntax
RunningAvg <BreakBy,SortBy>(Argument)
Where:
•
BreakBy is the attribute indicating where the calculation restarts.
•
SortBy is the attribute or metric by which the data is sorted.
•
Argument is a metric representing a list of numbers.
Expression
z k
=
1 k k
i = 1 y i
k = ,
Where:
• yi
= metric value at the i th
row
•
m = window size
•
n = number of rows/metric values
202
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Example
This simple example illustrates how the Running Average function walks through a list of values calculating and returning the new average with the addition of each value. The calculation is shown in the following table.
Values
10
20
30
40
50
Running Average
10 (10/1)
15 (30/2)
20 (60/3)
25 (100/4)
30 (150/5)
RunningCount
Returns the running count for each value in a list of values, returning the current count after each value. The count can be restarted based upon attributes identified in the paramenter settings. This is an OLAP function.
Syntax
RunningCount<BreakBy,SortBy>(Argument)
Where:
•
BreakBy is the attribute indicating where the calculation restarts.
•
SortBy is the attribute or metric by which the data is sorted.
•
Argument is a metric representing the list of values.
Expression
z k
= k
i = 1
1 i
k = ,
Where:
• 1i
= 0 if the i th
row of argument is NULL
1i
= 1 otherwise
•
n
= number of rows/metric values
© 2012 MicroStrategy, Inc.
OLAP functions
203
2
Standard Functions MicroStrategy Functions Reference
Example
This simple example demonstrates how the RunningCount function counts rows of data. This report uses the attributes Region and Employee, and the metrics Revenue and Running Count. A filter is applied so the only Regions displayed are South, Northwest, and Southwest. The Running Count metric is defined as follows:
RunningCount<BreakBy={Region}, SortBy= (Value)
>(Revenue)
•
The count restarts for every Region.
•
The entries are counted based on the value of the metric Revenue in ascending order (the lowest value is counted as 1, next lowest is 2, and so on).
RunningMax (running maximum)
Returns the running maximum value in a list of values by comparing the current and preceding values. The evaluation can restart based on attributes identified in the parameter settings. This is an OLAP function.
Syntax
RunningMax <BreakBy, SortBy>(Argument)
Where:
•
BreakBy is the attribute indicating where the calculation restarts.
204
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
•
SortBy is the attribute or metric by which the data is sorted.
•
Argument is a metric representing the list of numbers.
Expression
z k
= max i = ,
y i
k
= ,
Where:
• yi
= metric value at the i th
row
•
n = number of rows/metric values
Example
This simple example illustrates how the RunningMax function moves through a list of values comparing each value to the highest value identified so far and returning the maximum value as it progresses. The calculation is shown in the following table.
Values
8
6
10
9
5
Running Maximum
8 (8>6)
10 (10>8)
10 (10>9)
10 (10>5)
RunningMin (running minimum)
Returns the running minimum value in a list of values by comparing current and preceding values. The evaluation can restart based on attributes identified in the parameter settings. This is an OLAP function.
Syntax
RunningMin <BreakBy, SortBy> (Argument)
Where:
•
BreakBy is the attribute indicating where the calculation restarts.
© 2012 MicroStrategy, Inc.
OLAP functions
205
2
Standard Functions MicroStrategy Functions Reference
•
SortBy is the attribute or metric by which the data is sorted.
•
Argument is a metric representing the list of numbers.
Expression
z k
= min i = ,
y i
k
= ,
Where:
• yi
= metric value at the i th
row
•
n = number of rows/metric values
Example
This simple example illustrates how the Running Minimum function walks through a list of values comparing each value to the lowest value identified so far and returning the minimum value as it progresses. The calculation is shown in the following table.
Values
8
6
10
9
5
Running Minimum
6 (6<8)
6 (6<10)
6 (6<9)
5 (5<6)
RunningStDevP (running standard deviation of a population)
Returns the running standard deviation of a population for a value expression. The list of values supplied is the population. The calculation can restart based on attributes identified in the function parameter settings. This is an OLAP function.
Syntax
RunningStDevP <BreakBy, SortBy> (Argument)
Where:
•
BreakBy is the attribute indicating where the calculation restarts.
206
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
•
SortBy is the attribute or metric by which the data is sorted.
•
Argument is a metric representing the list of numbers.
Expression
z k
= k
i = 1
y i
– y
2 k
k = , ,
Where:
• yi
= metric value at the i th
row
•
n = number of rows/metric values
Example
This example shows a report where the running standard deviation of the revenue is calculated. This calculation is based on the assumption that the list of values supplied in the metric represents the entire population of the data for which you want to obtain the standard deviation. The calculation starts over for each region, and the information is sorted within the region by state in ascending order.
Compare this example report to the example for RunningStDev to see the different values returned when calculating for a population as opposed to a sample.
The report contains the attributes Customer Region and Customer State, and the metrics Total Revenue, RunningStDevP, and StDevP. A report filter limits data to the Southwest, Southeast, and Northwest regions. The definition of the RunningStDevP metric is as follows:
OLAP functions
207
© 2012 MicroStrategy, Inc.
2
Standard Functions MicroStrategy Functions Reference
RunningStDevP<BreakBy={[Customer Region]}, SortBy=
<[Customer State])>([Total Revenue])
RunningStDev (running standard deviation)
Returns the running standard deviation of a sample for a value expression.
The list of values supplied is the sample. The calculation can restart based on attributes identified in the function parameters. This is an OLAP function.
Syntax
RunningStDev<BreakBy,SortBy>(Argument)
Where:
•
BreakBy is the attribute indicating where the calculation restarts.
•
SortBy is the attribute or metric by which the data is sorted.
•
Argument is a metric representing the list of numbers.
Expression
z k
= k
y i
– y
2 i = 1 k 1
k = , ,
208
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Example
This example shows a report where the running standard deviation of the revenue is calculated. This calculation is based on the assumption that the list of values supplied in the metric represents a sample of the data for which you want to obtain the standard deviation. The calculation starts over for each region, and the information is sorted within the region by state in ascending order.
Compare this example report to the example for RunningStDevP to see the different values returned when calculating for a population as opposed to a sample.
The report contains the attributes Customer Region and Customer State, and the metrics Total Revenue, RunningStDev, and StDev. A report filter is used to limit the data to the Southwest, Southeast and Northwest regions. The definition of the RunningStDev metric is as follows:
RunningStDev<BreakBy={[Customer Region]}, SortBy=
<[Customer State])>([Total Revenue])
RunningSum
This function returns the running sum of the values in a list, adding the current value to the preceding values. It can be used to maintain running totals of values in specific categories as well as an entire set. The calculation
© 2012 MicroStrategy, Inc.
OLAP functions
209
2
Standard Functions MicroStrategy Functions Reference can restart based on attributes identified in the parameter settings. This is an
OLAP function.
Syntax
RunningSum <BreakBy,SortBy>(Argument)
Where:
•
BreakBy is the parameter that sets the attribute designating where the calculation restarts.
•
SortBy is the parameter that sets the attribute or metric by which the data is sorted.
•
Argument is a metric representing the list of numbers.
Expression
z k
= k
i = 1 y i
k = , ,
Example
Example 1: A running sum displays the results of each calculation as it works towards the total of a set of values. Using the value set (1, 2, 3, 4, 5), the following table illustrates the running sum and its calculations.
Values
3
4
1
2
5
Running Sum
1 (0+1)
3 (1+2)
6 (3+3
10 (6+4)
15 (10+5)
Example 2: This example shows a report where the running sum of the revenue is calculated. The calculation starts over for each region, and the information is sorted within the region by state in ascending order. The report contains the attributes Customer Region and Customer State, and the metrics Total Revenue and Running Sum. A report filter limits data to the
210
OLAP functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Southwest, Southeast, and Northwest regions. The definition of the Running
Sum metric is as follows:
RunningSum<BreakBy={[Customer Region]}, SortBy=
<[Customer State])>([Total Revenue])
Note that the subtotaled Total Revenue is equal to the last value in the
Running Sum column for each region.
Rank and NTile functions
Although Rank belongs to the OLAP functions group, it differs from the other OLAP function in that its SortBy parameter uses metrics, instead of attributes. In the VLDB Properties, a ranking option can be set in order to designate ranking by ODBC, the Analytical Engine, or the database.
NTile functions are used to group the values in an ordered list into one of several buckets or NTiles. Each element in the list is assigned an integer corresponding to the bucket to which it belongs. The various NTile functions differ in how the buckets are defined. Some functions allow you to define the number of buckets, others allow you to define the size of the buckets, and so on.
© 2012 MicroStrategy, Inc.
Rank and NTile functions
211
2
Standard Functions
NTile
MicroStrategy Functions Reference
NTile functions are used to group the values in an ordered list into one of several buckets or NTiles. For the Ntile function, the buckets are calculated so that each bucket has exactly the same number of rows assigned to it or at most one row more than the others (the exception is that identical value rows are placed in the same bucket). For example, if you have 100 rows in a partition and define an NTile function with four buckets, 25 rows will be assigned a value of 1, 25 rows will have value 2, and so on. These buckets are referred to as equiheight buckets.
If the number of rows in the partition does not divide evenly into the number of buckets, then, barring identical value rows, the number of rows assigned per bucket will differ by one at most. The extra rows are added to buckets using the calculations ceiling(1*(buckets/remainder)),..., ceiling(remainder*(buckets/remainder)).
For example, if there are 103 distinct value rows in a partition which has an
NTile<Tiles=5>() function, the first 20 rows will be in the first bucket, the next 21 in the second bucket, the next 20 in the third bucket, the next 21 in the fourth bucket, and the final 21 in the fifth bucket. The calculations ceiling(1*(5/3))=2, ceiling(2*(5/3))=4, and ceiling(3*(5/
3))=5 include one of the extra three rows each in the second, fourth, and fifth buckets.
NTile distributes the values in the specified metric, sorted in either ascending or descending order, over a user-defined number of buckets. Each bucket has an equal number of elements (if possible). This is an OLAP function.
Syntax
NTile <Ascending, Tiles, BreakBy> (Argument)
Where:
•
Ascending is a TRUE/FALSE parameter that designates the organization of data within the NTiles.
•
BreakBy is the parameter that sets the attribute determining where the calculation restarts.
•
Tiles is a positive integer that designates the number of buckets or
NTiles.
•
Argument is a metric representing a list of values to be distributed equally (if possible) into n buckets.
212
Rank and NTile functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Example
Example 1: If you define Tiles=4 for a metric that contains 20 values, the function distributes the numbers as follows:
•
Values 1 through 5 in bucket 1
•
Values 6 through 10 in bucket 2
•
Values 11 through 15 in bucket 3
•
Values 16 through 20 in bucket 4
Example 2: This example shows a report where the customer states were sorted based on revenue and then divided among a specified number of buckets. The number of buckets is defined as 8. The report includes the attribute Customer State and the metrics Total Revenue and NTile. The
NTile metric is a derived one, the syntax for which is as follows:
NTile<Tiles=8>([Total Revenue])
The resulting report divides the 48 states into 8 NTiles, each containing 6 elements (states). Within each band the data is sorted in ascending order by the attribute Customer State. A portion of the report is displayed as follows.
© 2012 MicroStrategy, Inc.
Rank and NTile functions
213
2
Standard Functions MicroStrategy Functions Reference
NTileSize
NTileSize distributes the values in the specified metric, sorted in either ascending or descending order, with the same number of elements in each bucket. The number of elements in each bucket is user-defined. This is an
OLAP function.
Syntax
NTileSize <Ascending, BreakBy> (Argument, Size)
Where:
•
Ascending is a TRUE/FALSE parameter that designates the organization of data within the Ntiles.
214
Rank and NTile functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
•
BreakBy is the parameter that sets the attribute determining where the calculation restarts.
•
Argument is a metric representing a list of values to be distributed in buckets.
•
Size is a positive integer that designates the number of elements per bucket.
Example
Example 1: If you define the Size as 2, the function returns buckets containing two values each. If there are six values, values one and two go in bucket 1, values three and four go in bucket 2, and values five and six go in bucket 3.
Example 2: This example shows a report where the customer states are sorted by revenue and then placed in buckets based on the number of elements that can fit in a bucket. The number of elements per bucket size is defined as 8. The report includes the attributes Customer State and the metrics Total Revenue and NTileSize. The syntax for the NTileSize metric is as follows:
NTileSize ([Total Revenue],8)
© 2012 MicroStrategy, Inc.
Rank and NTile functions
215
2
Standard Functions MicroStrategy Functions Reference
The resulting report divides the 48 states into 6 buckets each containing 8 elements (states). A portion of the resulting report displays as follows.
NTileValue
NTileValue distributes the values in the metric by value ranges over a user-defined number of buckets, sorted in either ascending or descending order. Each bucket is the same size in terms of the range of values contained in the bucket, but the number of elements per bucket is not equal. This is an
OLAP function.
Syntax
NTileValue <Ascending, Segments, BreakBy> (Argument)
216
Rank and NTile functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Where:
•
Ascending is a TRUE/FALSE parameter that designates the organization of data within the Ntiles.
•
Segments is a positive integer designating the number of buckets in which the values are distributed.
•
BreakBy is the parameter that sets the attribute determining where the calculation restarts.
•
Argument is a metric representing a list of values to be distributed into buckets.
Example
Example 1: If you define the Segments= 4, and the minimum value in the range is 5 and the maximum is 105, the bucket distribution is as follows, where x is the value:
•
5
x <
30
in bucket 1
•
30
x <
55
in bucket 2
•
55
x <
80 in bucket 3
•
80
x
105
in bucket 4
Example 2: This example shows a report where the customer states are sorted based on revenue and then placed in buckets based on the value range to which they belong. The number of buckets (segments) is defined as 4. The range of values is divided by the number of buckets and the result used to define four value ranges into which all the values fall. The report includes the attribute Customer State and the metrics Total Revenue and NTileValue. The syntax for the NTileValue metric is as follows:
NTileValue<Segments=4>([Total Revenue])
The resulting report displays the 48 states distributed across 4 buckets.
Notice that the number of elements in each bucket is not equal as more
© 2012 MicroStrategy, Inc.
Rank and NTile functions
217
2
Standard Functions MicroStrategy Functions Reference values fall into one range than another. A portion of the resulting report is displayed as follows.
Example 3: Histogram
The reports and components used in this example are available in the
MicroStrategy Tutorial under the following folder: MicroStrategy
Tutorial\Public Objects\Reports\TechnicalReports\
Reports by Feature\Analytics\Statistics and
Forecasting\Histogram
How are my customers distributed (classified) based on sales data?
You are interested in finding out how your customers are distributed based on their contributions to sales data. This example segments customers into
10 separate groups, with each group representing the customers within a
10% increment of sales. For example, the first segment includes the customers who spend in the lowest 10% of the sales, while the final, tenth segment includes the customers who spend in the top 10% of the sales.
218
Rank and NTile functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
This example uses the following concepts:
•
Analytical functions: NTileValue
•
Custom group
NTileValue distributes values into buckets based on minimum and maximum values. These tiles are assigned an integer and the contents of each bucket denoted accordingly. For example, all customers that fall in the first bucket are assigned a 1, all customers in the second bucket are assigned a 2, and so on. This function is computed by Intelligence Server. The metric using NTileValue is then used to create a dynamic classification of Customers using a custom group.
To create a general solution that can be used by different users, use object prompts (see instructions below).
Create the following object prompts:
•
Choose a base fact. This object prompt asks the user to select a fact:
Revenue, Profit, or Units Sold.
© 2012 MicroStrategy, Inc.
Rank and NTile functions
219
2
Standard Functions MicroStrategy Functions Reference
•
Choose a sample set level. This object prompt asks the user to select an attribute: Customer, Item, or Day.
Once you have identified the basic fact and attribute to analyze, you can start building other objects. Take the following steps:
1
Create a metric defined as follows:
Sample Set Metric = Sum(?[Choose a base fact]){~,
?[Choose a sample set level]}
2
To put the value in the proper buckets (tiles), create another metric defined as:
Decile By Value = NTileValue<Segments=10> ([Sample Set
Metric])
3
Create a dynamic classification of the subject attribute (Customers, Item, or Day) by building a custom group using banding. Use the metric Decile
220
Rank and NTile functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
By Value, the banding type “band count” and set the band count to 10, starting at 1 and stopping at 10.
4
Choose to show only individual items within this element since the objective is to build a graph (histogram) for this custom group.
© 2012 MicroStrategy, Inc.
Rank and NTile functions
221
2
Standard Functions MicroStrategy Functions Reference
5
Count the number of elements in the new classification to display a histogram. To do this, create a dummy metric defined as follows:
Count of Samples = Count(1){~}
6
Since there is no column to perform the count, define the metric so that the database can calculate how many attribute elements are in each custom group element.
7
Add the Decile by Value custom group to the row axis, and the Count of
Samples metric to the column axis.
8
Execute the report with attribute Customer and fact Revenue, and the
Decile Histogram, in Grid mode, displays as follows:
222
Rank and NTile functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
The same report, in graph mode, appears as follows:
Standard Functions 2
The SQL generated for the Decile by Histogram is as follows:
Pass0 - Duration: 0:00:00.25
select a11.[CUSTOMER_ID] AS CUSTOMER_ID, a11.[TOT_DOLLAR_SALES] AS WJXBFS1 from [CUSTOMER_SLS] a11
Pass1 - Duration: 0:00:00.09
create table ZZT1Y02011CMQ000 (
CUSTOMER_ID SHORT,
DA56 LONG)
Pass2 - Duration: 0:00:00.00
[An Analytical SQL]
© 2012 MicroStrategy, Inc.
Rank and NTile functions
223
2
Standard Functions MicroStrategy Functions Reference
Pass3 - Duration: 0:01:13.64
insert into ZZT1Y02011CMQ000 values (1499, 1)
Pass4 - Duration: 0:00:00.32
select a11.[DA56] AS DA56, count(1.0) AS WJXBFS1 from [ZZT1Y02011CMQ000] a11 group by a11.[DA56]
Pass5 - Duration: 0:00:00.03
drop table ZZT1Y02011CMQ000
•
Pass0 computes the revenue for each Customer using the Sample Set
Metric.
•
The next three passes (Pass1, Pass2, and Pass3) prepare the dynamic classification of Customer for the custom group. This series of SQL passes essentially builds a dynamic lookup table for the classification that is requested. The column DA stands for Dynamic Attribute. The
Intelligence Server computes the NTileValue function. This is indicated by [An Analytical SQL] in Pass3. The value is then inserted, with the new classification, into the dynamic lookup table for the custom group.
•
Pass4 calculates the number of customers that belong to each custom group element.
•
Pass5 drops the temporary table.
NTileValueSize
NTileValueSize distributes the values in the metric across buckets based on a user-specified value range, sorted in either ascending or descending order. This is an OLAP function.
Syntax
NTileValueSize <Ascending, BreakBy> (Argument, Size)
224
Rank and NTile functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Where:
•
Ascending is a TRUE/FALSE parameter that designates the organization of data within the Ntiles.
•
BreakBy is the parameter that sets the attribute determining where the calculation restarts.
•
Argument is a metric representing the list of values to be distributed across buckets.
•
Size is a real number designating the size of the range of values for each bucket.
Example
Example 1: If you define size as 1000 and your range of values begins at
1200, the first bucket contains values 1200 through 2199, the second bucket contains values 2200 through 3199, and so on until every value is in a bucket.
It does not matter how many values are in each bucket; it only matters that their value is within the bucket range.
Example 2: This example shows a report where the customer states were sorted based upon revenue and then placed in buckets based upon the value range to which they belong. The value range is defined as 100,000.
Beginning at the lowest metric value, in this case 18, 654, the first bucket contains values from 18,654 to 118,653, the next bucket ranges from 118654 to 218,653, and so on until all values are in buckets. The highest value in the report is 1,839,238, which falls into bucket 19 and is the only value in that range.
The report includes the attribute Customer State and the metrics Total
Revenue and NTileValueSize. The syntax for the NTileValueSize metric is as follows:
NTileValueSize ([Total Revenue], 100000)
© 2012 MicroStrategy, Inc.
Rank and NTile functions
225
2
Standard Functions MicroStrategy Functions Reference
A portion of the resulting report is displayed as follows.
Percentile
Returns the n th
percentile of values in a given range. This function can be used to establish thresholds indicating, for example, which states have revenue above the 75th percentile for their region. This is a group-value function.
Syntax
Percentile <Ascending, FactID> (Argument, Percent)
Where:
•
Ascending is a TRUE/FALSE parameter that indicates the organization of the data.
•
Argument is an attribute, fact or metric representing a list of numbers.
•
Percent is the decimal value of the percent for which you want to use as a threshold.
226
Rank and NTile functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Example
Example 1: If you have an argument containing the values 1, 2, 3, and 4 and you want to find the threshold of the 3oth percentile, the syntax is as follows:
Percentile ({1, 2, 3, 4}, 0.3) = 1.9
1.9 is the level of the 30th percentile. All values above 1.9 are greater than the
30th percentile.
Example 2: This example shows a report where only states with Total
Revenue greater than the threshold for the 75th percentile in its region are displayed. The report contains the attributes Customer Region and Customer
State, and the metrics Total Revenue and Percentile. A view filter is then applied to the report so that it only displays states where Total Revenue is greater than Percentile.
The syntax for the Percentile metric is as follows:
Percentile([Total Revenue], .75){[Customer Region]}
Rank
This function is used to display the ranking of values in a list relative to the other values. The calculation can restart based on attributes identified in the parameter settings. This is an OLAP function.
Unless the defaults are changed, the function ranks the values in ascending order by the value of the metric, and the rank is an integer.
© 2012 MicroStrategy, Inc.
Rank and NTile functions
227
2
Standard Functions MicroStrategy Functions Reference
Syntax
Rank <ASC, ByValue, BreakBy, NullInclude> (Argument)
Where:
•
Argument is a fact or metric representing a list numbers.
•
ASC is a TRUE/FALSE parameter that indicates the order of ranking (1 is the lowest or highest value).
•
ByValue is a TRUE/FALSE parameter that indicates whether the ranking is done by integer values (1, 2, 3, 4) or by percentage (10%, 50%, 75%,
100%).
•
BreakBy is the parameter that designates where the calculation should restart.
•
NullInclude is a parameter that determines how NULL values are included in the rank calculation.
The NullInclude parameter only affects the rank of NULL values if the
Rank function is performed by the MicroStrategy Analytical Engine. The
Rank function is performed by the Analytical Engine for smart metrics, derived metrics, and other metric scenarios. To determine whether the
Rank function for a metric is performed by the Analytical Engine, view the SQL statement for the report. If the metric is listed in the Analytical
Engine calculation steps, this verifies that the Rank function is performed by the Analytical Engine.
If the Rank function is performed on a database, the NullInclude parameter is ignored and NULL values are included in the rank calculation based on the database standards.
For Rank functions that are performed by the Analytical Engine, you have the following options for this parameter:
1
: If you define NullInclude=1, NULL values are given a rank value equal to the number of other rank values, plus one. For example, the rank of the Profit metric in the report below ranks four separate profit values.
228
Rank and NTile functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
There is one NULL value, which is given the rank of 4. The Rank
(Profit) metric in this example uses an ascending rank. If you define the metric with a descending rank, the other rank values change but the rank value for any NULL values remains the same. This is shown in the report below.
-1
: If you define NullInclude=-1, NULL values are given the rank value of one. For example, the reports shown below both define the
Rank (Profit) metric with NullInclude=-1. The report on the left uses an ascending rank, while the report on the right uses a descending rank.
As shown in the reports above, the NULL values for both reports are ranked with the value of one.
0
(default): If you define NullInclude=0, NULL values are included in the rank calculation based on the NULL value handling defined using the Null checking for Analytical Engine VLDB property. For information on VLDB properties, including steps to access and modify them for various MicroStrategy objects, refer to the Supplemental
Reference for System Administration:
– If you define the Null checking for Analytical Engine property as
True, NULL values are treated as zero values in the rank calculation. For example, the report shown below ranks the NULL
© 2012 MicroStrategy, Inc.
Rank and NTile functions
229
2
Standard Functions MicroStrategy Functions Reference values with a rank of two, because zero is greater than -10 and less than 40.
– If you define the Null checking for Analytical Engine property as
False, NULL values are treated as NULL values, which means
NULL values are also displayed for the rank values. For example, the report shown below displays the NULL values as NULL in the rank.
Example
This example report displays customer states ranked by revenue within their regions. There are two metrics, one that ranks by value (default) and the other that ranks using a percentage. In order to have the state with the highest revenue in each region ranked as 1 in the Rank by Value metric, the
Rank by Value ranking is descending. In order to have the largest number ranked at 100% in the Rank by Percent metric, the ranking is ascending
(default).
The report includes the attributes Customer Region, Customer State, the metric Total Revenue (defined as Sum(Revenue)), and the two ranking metrics. The syntax for the metrics is as follows:
230
Rank and NTile functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Rank by Value:
Rank<ASC=False,ByValue=True, BreakBy={[Customer
Region]}>([Total Revenue])
Rank by Percent:
Rank<ASC=True,ByValue=False BreakBy={[Customer
Region]}>([Total Revenue])
The resulting report is displayed as follows.
String functions
String functions perform various actions that modify the characters returned for a string of characters. While string functions can be used to create metrics, a more common use case for these functions is in the creation of attribute forms. For example, these functions can aid in the creation of attribute forms by combining multiple columns of information, capitalizing the first letter of a column, removing or returning select characters of a column, and so on. For information on creating attributes and attribute forms, see the Project Design Guide.
The MicroStrategy Analytical Engine does not calculate string functions; they are processed by the database. For information on which string functions are supported for your specific database, refer to
MicroStrategy and Database Support for Functions
, and search in the
© 2012 MicroStrategy, Inc.
String functions
231
2
Standard Functions MicroStrategy Functions Reference section corresponding to your database. String functions for which your database does not include SQL syntax support cannot be calculated in your environment.
This section of the document includes information and examples on the data returned by the function.
Concat (concatenate)
The Concat function combines two or more input strings into one continuous string and returns the result. For example, concatenating the two strings “Micro” and “Strategy” would result in the single string
“MicroStrategy”. Concat is often used to combine related values, such as a first and last name.
Syntax
Concat(Argument1, Argument2,..., ArgumentN)
Where:
•
Argument1,..., ArgumentN are facts, metrics, columns, or string values.
For information on the syntax used in your specific database, refer to
Appendix A, MicroStrategy and Database Support for Functions
and search in the section that corresponds to your database.
Example
The Concat function can help to create attribute forms that are a combination of multiple columns in database tables. For example, an
LU_CUSTOMER table includes two columns: CUST_FIRST_NAME and
CUST_LAST_NAME. You can create a single attribute form that combines these two columns as described below.
Concat([CUST_FIRST_NAME], [CUST_LAST_NAME])
The input from the first column is concatenated with the input from the second column, to display information such as JohnDoe and JaneDoe for the attribute form.
For scenarios such as the one described above, you can use the
ConcatBlank function (see
ConcatBlank (concatenate plus blank space)
below) to concatenate the strings and include a space between
232
String functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2 the two strings. This can result in attribute forms that are easier to read. For example, rather than displaying JohnDoe, the attribute form would display John Doe.
For an additional example of using the Concat function, refer to the example section for the function
InitCap (initial capitalization), page 234
.
ConcatBlank (concatenate plus blank space)
The ConcatBlank function concatenates two or more input strings into one continuous string, inserting a blank space between each string. This function can be used to combine related values that are logically separated by spaces.
For example, concatenating the two strings “Business” and “Intelligence” would result in the single string “Business Intelligence”.
Syntax
ConcatBlank (Argument1, Argument2,..., ArgumentN)
Where:
•
Argument1,..., ArgumentN are facts, metrics, columns, or string values.
For information on the syntax used in your specific database, refer to
Appendix A, MicroStrategy and Database Support for Functions
and search in the section that corresponds to your database.
Example
The ConcatBlank function can help to create attribute forms that are a combination of multiple columns in database tables. For example, an
LU_CUSTOMER table includes two columns: CUST_FIRST_NAME and
CUST_LAST_NAME. You can create a single attribute form that combines these two columns as described below.
ConcatBlank([CUST_FIRST_NAME], [CUST_LAST_NAME])
The input from the first column is concatenated with the input from the second column, and an additional space is included between the two inputs.
This displays information such as John Doe and Jane Doe for the attribute form.
String functions
233
© 2012 MicroStrategy, Inc.
2
Standard Functions MicroStrategy Functions Reference
For an additional example of using the ConcatBlank function, refer to the example section for the function
InitCap (initial capitalization), page 234
.
InitCap (initial capitalization)
The InitCap function returns a string in which the first letter of the input string is capitalized. All other letters appear in lower case. This can help to fix capitalization errors in information that is displayed for attribute forms, metrics, and other objects.
Syntax
InitCap(Argument)
Where:
•
Argument is a metric, column, or string value representing the text string.
For information on the syntax used in your specific database, refer to
Appendix A, MicroStrategy and Database Support for Functions
and search in the section that corresponds to your database.
Example
The InitCap function can be used to fix capitalization errors for information that is displayed for attribute forms. For example, an
LU_CUSTOMER table includes two columns: CUST_FIRST_NAME and
CUST_LAST_NAME. To ensure that the first letter of the last name is capitalized you create an attribute form with the following definition.
InitCap([CUST_LAST_NAME])
The input from the column is modified so that the first character is capitalized and all other characters are lowercase. For example, if the column included information such as jackson, sMITh, and Hughes, these would be displayed as Jackson, Smith, and Hughes respectively.
Be aware that this function could potentially return undesired results in certain scenarios. Using the scenario described above, consider the name
McCoy. Using the InitCap function, this would be displayed as Mccoy.
Another way to use this function would be to create an attribute form that combined the first letter of someone’s first name with the person’s full last
234
String functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2 name. The InitCap function could be used to ensure that the first letter of the first name was capitalized. An attribute form of this type would require the use of the functions InitCap, ConcatBlank, Concat, and LeftStr.
The definition of such an attribute form is shown below:
ConcatBlank(Concat(LeftStr(InitCap([CUST_FIRST_NAME]),
1), "."), [CUST_LAST_NAME])
An attribute form using a definition such as the one listed above would display names such as J. Doe, M. Smith, and L. Martinez. The InitCap function ensures that the first letter of the first name is capitalized.
LeftStr (left string selection)
The LeftStr function returns a substring taken as a specified number of characters from the left of the input string. For example, if the specified length is five, LeftStr would return the string “Micro” from the original string “MicroStrategy”. LeftStr is useful for abbreviations or length reduction when the entire input string is not required.
Syntax
LeftStr (Argument, Length)
Where:
•
Argument is a metric, fact, column, or string value representing the text string(s).
•
Length is an integer indicating the number of characters, starting from the far left position of the string, to be returned.
For information on the syntax used in your specific database, refer to
Appendix A, MicroStrategy and Database Support for Functions
and search in the section that corresponds to your database.
Example
The LeftStr function can be used to create attribute forms that use abbreviations. This can help reduce the length for attribute forms that may have long descriptions.
For example, an LU_CUSTOMER table includes two columns:
CUST_FIRST_NAME and CUST_LAST_NAME. You create attribute forms for the customer first and last names. You also create an attribute form that
String functions
235
© 2012 MicroStrategy, Inc.
2
Standard Functions MicroStrategy Functions Reference displays only the first letter of the first name. This attribute form can be used when the full first name does not need to be displayed. The definition of such an attribute form is shown below:
LeftStr([CUST_FIRST_NAME], 1)
The integer value of 1 causes the LeftStr function to only display the first character at the far left position for all inputs from the CUST_FIRST_NAME column.
For an additional example of using the LeftStr function, refer to the example section for the function
InitCap (initial capitalization), page 234
.
Length (length of string)
The Length function returns the number of characters in an input string.
For example, using the Length function on the string “MicroStrategy” would return a value of 13. Length is often used to manipulate strings with the help of other string functions.
Syntax
Length(Argument)
Where:
•
Argument is a metric, fact, column, or string representing the text string(s).
For information on the syntax used in your specific database, refer to
Appendix A, MicroStrategy and Database Support for Functions
and search in the section that corresponds to your database.
Example
The Length function can be used in conjunction with other string functions to manipulate strings in various ways. For example, rather than abbreviating information to a specific number of characters, you can abbreviate each string to only display half of the available characters. The definition of an attribute form that displays only half of the characters available for the first names of a customers is shown below:
LeftStr([CUST_FIRST_NAME], Int(Length([CUST_FIRST_NAME])
/ 2))
236
String functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
For first names such as Alan, Frederick, and Jennifer, the function shown above would display Al, Fred, and Jenn, respectively. This provides an abbreviated version of customers’ first names while providing additional characters to possibly distinguish each abbreviated name.
In the function used in this example, the Int function is used to return only the integer part of the calculation
Length([CUST_FIRST_NAME]) / 2. Depending on your database’s support for functions, you could also use functions such as
Round, Ceiling, and Floor. For information on these types of functions, see
Mathematical functions, page 323
Lower (lower case)
The Lower function returns a string in which all alphabetic characters in an input string are displayed as lower case. For example, using the Lower function on the string “MicroStrategy” would return the string
“microstrategy”.
Lower may be used to help standardize the display of information and make the information more readable.
Syntax
Lower(Argument)
Where:
•
Argument is a metric, column, or string value representing the text string(s).
For information on the syntax used in your specific database, refer to
Appendix A, MicroStrategy and Database Support for Functions
and search in the section that corresponds to your database.
Example
The Lower function can be used to display information in all lower case for attribute forms. For example, an LU_CUSTOMER table includes an ADDRESS column. You can create an attribute form to display all characters for a customer’s address in lower case. The definition of such an attribute form is shown below:
Lower([ADDRESS])
String functions
237
© 2012 MicroStrategy, Inc.
2
Standard Functions MicroStrategy Functions Reference
An attribute form using a definition such as the one listed above would take input addresses such as 10 Main Street, 350 West Elm Avenue, and 4400
Spring Road and display them as 10 main street, 350 west elm avenue, and
4400 spring road, respectively.
LTrim (left trim)
The LTrim function returns a string in which any leading blank spaces on the left side of the input string have been removed. For example, using the
LTrim function on the string “ MicroStrategy” would return the string
“MicroStrategy”.
The LTrim function helps to remove blank spaces that may have been caused by errors in data entry. Removing these spaces helps standardize the display of information and makes the information more readable.
Syntax
LTrim(Argument)
Where:
•
Argument is a metric, fact, column, or string representing the text string(s).
For information on the syntax used in your specific database, refer to
Appendix A, MicroStrategy and Database Support for Functions
and search in the section that corresponds to your database.
Example
An LU_CUSTOMER table includes an ADDRESS column. You can create an attribute form to remove any leading blank spaces from the addresses. The definition of such an attribute form is shown below:
LTrim([ADDRESS])
Any leading blank spaces included for addresses are removed from the display for the attribute form.
To remove both leading and trailing blank spaces, use the Trim function
).
238
String functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Position (position of substring)
The Position function returns the starting position of the first occurrence of a series of characters in the input string. For example, using the
Position function to search for the string “Strategy” within the string
“MicroStrategy” would return the value of 6.
In addition to locating the position of a substring, Position also can be used to test whether the substring is present. If a given substring is not found, 0 will be returned.
Syntax
Position (Argument1, Argument2)
Where:
•
Argument1 is the substring to search for.
•
Argument2 is the string in which to search for Argument1.
For information on the syntax used in your specific database, refer to
Appendix A, MicroStrategy and Database Support for Functions
and search in the section that corresponds to your database.
Example
The Position function can be used in conjunction with other functions to perform various manipulations on strings. For an example of how this function works, consider an LU_CUSTOMER table that includes an ADDRESS column. You use the Position function to find the word Street in the addresses as defined below.
Position(“Street”, [ADDRESS])
For an address of 10 Main Street, the function listed above returns the value of 9. For addresses that do not include the word Street, a value of 0 would be returned.
RightStr (right string selection)
The RightStr function returns a substring taken as a specified number of characters from the right of the input string. For example, the first eight characters from the right of the string “MicroStrategy” would be “Strategy”.
String functions
239
© 2012 MicroStrategy, Inc.
2
Standard Functions MicroStrategy Functions Reference
RightStr can be used to create attribute forms that display only part of the information available. This can be helpful when some information needs to be hidden for security purposes, as in the credit card example below.
Syntax
RightStr (Argument, Length)
Where:
•
Argument is a metric, fact, column, or string representing the text string(s).
•
Length is an integer indicating the number of characters to be returned.
For information on the syntax used in your specific database, refer to
Appendix A, MicroStrategy and Database Support for Functions
and search in the section that corresponds to your database.
Example
An LU_CUSTOMER table includes a CREDIT_CARD_NUMBER column that contains credit card numbers for online customers. You create attribute forms to display only the last four digits of the customers’ credit card numbers. The definition of such an attribute form is shown below:
RightStr([CREDIT_CARD_NUMBER], 4)
The integer value of 4 causes the RightStr function to only display the last four characters from the CREDIT_CARD_NUMBER column.
You could also combine this functionality with the Concat function to display Xs or other characters to represent the digits for the credit card that are not displayed.
Concat(“XXXX-XXXX-XXXX-”, RightStr([CREDIT_CARD_NUMBER],
4))
This definition would modify the display of a credit card number from
1111-2222-3333-4444 to be displayed as XXXX-XXXX-XXXX-4444.
RTrim (right trim)
The RTrim function returns a string in which blank spaces on the right side of the input string have been removed. For example, using the RTrim
240
String functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2 function on the string “MicroStrategy ” would return the string
“MicroStrategy”.
RTrim helps to remove trailing blank spaces, which may have been caused by errors in data entry. Removing these spaces helps standardize the display of information and makes the information more readable.
Syntax
RTrim(Argument)
Where:
•
Argument is a metric, fact, column, or string representing the text string(s).
For information on the syntax used in your specific database, refer to
Appendix A, MicroStrategy and Database Support for Functions
and search in the section that corresponds to your database.
Example
An LU_CUSTOMER table includes an ADDRESS column. You can create an attribute form to remove any trailing blank spaces from the addresses. The definition of such an attribute form is shown below:
RTrim([ADDRESS])
Any trailing blank spaces included in the addresses are removed from the display for the attribute form.
To remove both leading and trailing blank spaces, use the Trim function
).
SubStr (substring selection)
The SubStr function returns a substring taken as a specified sequence of characters from the input string. SubStr is useful for isolating a specific section of a string that contains relevant information.
Syntax
SubStr(Argument, Position, Length)
String functions
241
© 2012 MicroStrategy, Inc.
2
Standard Functions MicroStrategy Functions Reference
Where:
•
Argument is a metric, fact, column, or string representing the text string(s).
•
Position is an integer indicating the starting position inside the string.
•
Length is an integer indicating the number of characters to be returned.
For information on the syntax used in your specific database, refer to
Appendix A, MicroStrategy and Database Support for Functions
and search in the section that corresponds to your database.
Example
An LU_ITEM table includes an ITEM_ID column. This column stores a ten-digit number, which has been created to define various facts about the item. This includes two digits which identify the location in which the item is sold. These two digits always start at the fourth digit from the left side of the ten-digit item ID number. To retrieve these digits and determine the location of sale for an item, you can create an attribute form to return these two digits.
The definition of such an attribute form is shown below:
SubStr(ITEM_ID, 4, 2)
The substring retrieved starts at the fourth digit and retrieves two characters.
For an item ID of 2334560897, this function returns 45.
Trim
The Trim function returns a string in which blank spaces on either side of the input string have been removed. For example, using the Trim function on the string “ MicroStrategy ” would return the string “MicroStrategy”.
The Trim function helps to remove leading and trailing blank spaces, which may have been caused by errors in data entry. Removing these spaces helps standardize the display of information and makes the information more readable.
Syntax
Trim(Argument)
242
String functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Standard Functions 2
Where:
•
Argument is a metric, fact, column, or string representing the text string(s).
For information on the syntax used in your specific database, refer to
Appendix A, MicroStrategy and Database Support for Functions
and search in the section that corresponds to your database.
Example
An LU_CUSTOMER table includes an ADDRESS column. You can create an attribute form to remove any leading and trailing blank spaces from the addresses. The definition of such an attribute form is shown below:
RTrim([ADDRESS])
Any leading or trailing blank spaces included in the addresses are removed from the display for the attribute form.
Upper (upper case)
The Upper function returns a string in which all alphabetic characters in an input string are displayed as upper case. For example, using the Upper function on the string “MicroStrategy” would return the string
“MICROSTRATEGY”. The Upper function can be used to display information in all upper case for attribute forms.
Syntax
Upper(Argument)
Where:
•
Argument is a metric, column, or string representing the text string(s).
For information on the syntax used in your specific database, refer to
Appendix A, MicroStrategy and Database Support for Functions
and search in the section that corresponds to your database.
String functions
243
© 2012 MicroStrategy, Inc.
2
Standard Functions MicroStrategy Functions Reference
Example
An LU_CUSTOMER table includes an ADDRESS column. You can create an attribute form to display all characters for a customer’s address in upper case. The definition of such an attribute form is shown below:
Upper([ADDRESS])
An attribute form using a definition such as the one listed above would take input addresses such as 10 Main Street, 350 West Elm Avenue, and 4400
Spring Road and display them as 10 MAIN STREET, 350 WEST ELM
AVENUE, and 4400 SPRING ROAD, respectively.
244
String functions © 2012 MicroStrategy, Inc.
3
3.
O
PERATORS
Introduction
The operators described in this chapter are building block functions. They provide the means to perform simple mathematical operations, compare values, search strings, and evaluate logical conditions.
The following categories of operators are covered in this chapter:
•
Arithmetic operators, page 246
•
Comparison operators, page 248
•
Comparison for rank operators, page 259
•
© 2012 MicroStrategy, Inc.
245
3
Operators MicroStrategy Functions Reference
Arithmetic operators
The arithmetic operators are basic mathematical functions, such as Minus,
Times, Divide, Plus, and Unary Minus, which are among the most commonly used operators. A brief description of each operator follows.
Minus (-)
Returns the difference between two values.
Syntax
Arg1 - Arg2
Where:
Arg1 and Arg2 are attributes, facts, metrics representing a list of numbers, big decimals, date/time, or functions that return numbers or big decimals.
Both Arg1 and Arg2 must be of the same data type, with the exception if
Arg1 is a Date data type. In this case, Arg2 must be a number.
Example
A metric is defined as:
Revenue - Freight
This metric returns the difference between the revenue and freight charges.
Times (*)
Returns the product of two values.
Syntax
Arg1 * Arg2
Where:
Arg1 and Arg2 are attributes, facts, metrics representing a list of numbers, big decimals, or functions that return numbers or big decimals.
246
Arithmetic operators © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Operators 3
Example
A metric is defined as:
([Unit Profit] * [Units Sold])
This metric returns the product of the unit profit and the units sold values.
Divide (/)
Returns the quotient when one value is divided by another.
Syntax
Arg1 / Arg2
Where:
Arg1 and Arg2 are attributes, facts, metrics representing a list of numbers, big decimals, or functions that return numbers or big decimals. In addition,
Arg2 must not be zero.
Example
A metric is defined as:
(Profit / [Units Sold])
This metric returns the quotient of the profit and number of units sold.
Plus (+)
Returns the sum of two values.
Syntax
Arg1 + Arg2
Where:
Arg1 and Arg2 are attributes, facts, or metrics representing a list of numbers, big decimals, or functions that return numbers and big decimals.
© 2012 MicroStrategy, Inc.
Arithmetic operators
247
3
Operators MicroStrategy Functions Reference
In addition, if either of the two arguments is date/time, the other argument must be a number.
Example
A metric is defined as:
Cost + Freight
This metric returns the sum of the cost and the freight charges.
Unary minus (U-)
Returns the absolute value of a negative value or the negative value of a positive value.
Syntax
U-(Arg)
Where:
Arg is an attribute, fact, metric representing a list of numbers, or a function that returns numbers and big decimals.
Example
A metric is defined as:
U-(Profit)
This metric changes the sign of the profit value. If the profit value is negative, it returns a positive value. If the profit value is positive, it returns a negative value.
Comparison operators
These functions are used to compare values, which can be numbers, text strings, date and time, expressions, or functions that return any values of the mentioned data types. A brief description of each operator follows. The
248
Comparison operators © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Operators 3 comparison patterns of text strings may or may not be case-sensitive depending on the database implementation.
Less than (<)
Returns TRUE if the first value is less than the second value.
Syntax
Arg1 < Arg2
Where:
Arg1 and Arg2 are attributes, facts, or metrics representing a list of numbers, text strings, date/time, or functions that return literal values. Arg1 and Arg2 must be of the same data type.
Example
A condition is defined as:
Profit < Cost
This condition returns TRUE only if the profit is less than the cost.
Less than or equal (<=)
Returns TRUE if the first value is less than or equal to the second value.
Syntax
Arg1 <= Arg2
Where:
Arg1 and Arg2 are attributes, facts, or metrics representing a list of numbers, text strings, date/time, or functions that return literal values. Arg1 and Arg2 must be of the same data type.
© 2012 MicroStrategy, Inc.
Comparison operators
249
3
Operators MicroStrategy Functions Reference
Example
A condition is defined as:
Profit <= Cost
This condition returns TRUE only if the profit is less than or equal to the cost.
Not equal (<>)
Returns TRUE if two given values are not equal to each other.
Syntax
Arg1 <> Arg2
Where:
Arg1 and Arg2 are attributes, facts, metrics representing a list of numbers, text strings, date/time, or functions that return literal values. Arg1 and
Arg2 must be of the same data type.
Example
A condition is defined as:
Profit <> Cost
This condition returns TRUE only if the profit is not equal to the cost.
Equal (=)
Returns TRUE if the two given values are equal to each other.
Syntax
Arg1 = Arg2
250
Comparison operators © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Operators 3
Where:
Arg1 and Arg2 are attributes, facts, metrics representing a list of numbers, text strings, date/time, or functions that return literal values. Arg1 and
Arg2 must be of the same data type.
Example
A condition is defined as:
Profit = Cost
This condition returns TRUE if the profit is equal to the cost.
Greater (>)
Returns TRUE if the first value is greater than the second value.
Syntax
Arg1 > Arg2
Where:
Arg1 and Arg2 are attributes, facts, metrics representing a list of numbers, text strings, date/time, or functions that return literal values. Arg1 and
Arg2 must be of the same data type.
Example
A condition is defined as:
Profit > Cost
This condition returns TRUE only if the profit is greater than the cost.
Greater than or equal (>=)
Returns TRUE if the first value is greater than or equal to the second value.
© 2012 MicroStrategy, Inc.
Comparison operators
251
3
Operators MicroStrategy Functions Reference
Syntax
Arg1 >= Arg2
Where:
Arg1 and Arg2 are attributes, facts, metrics representing a list of numbers, text strings, date/time, or functions that return literal values. Arg1 and
Arg2 must be of the same data type.
Example
A condition is defined as:
Profit >= Cost
This condition returns TRUE only if the profit is greater than or equal to the cost.
Begins with
Returns TRUE if a text string begins with a specified text pattern.
Syntax
Arg1 Begins With Arg2
Where:
Arg1 and Arg2 are text strings.
The text pattern comparison may or may not be case sensitive depending on the database implementation.
Example
Region@DESC Begins with "North"
Returns TRUE for Regions, such as, “Northeast”, “Northwest”.
252
Comparison operators © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Operators 3
Between
Returns TRUE if the specified value is between the inclusive range of two boundaries. Between can be used to test if a value is within a valid data range.
Syntax
Value Between Boundary1 and Boundary2
Where:
•
Value, Boundary1, and Boundary2 can be numbers, date/time, text, or functions that return the mentioned data types. Value, Boundary1 and Boundary2 must be of the same data type.
Example
•
M1 Between 1 and 1000
•
region@DESC Between "A" and "Z"
•
date@DESC Between '1999-2-12' and '2005-2-23'
Contains
Returns TRUE if a text string contains a specified text pattern.
Syntax
Arg1 Contains Arg2
Where:
Arg1 and Arg2 must be of data type Text.
Example
Employee@[Last Name] Contains "Smith"
Returns TRUE for Employees with a last name such as “Smith”, “Smithson”, and so on.
© 2012 MicroStrategy, Inc.
Comparison operators
253
3
Operators MicroStrategy Functions Reference
Ends with
Returns TRUE if a text string ends with a specified text pattern.
Syntax
Arg1 Ends With Arg2
Where:
Arg1 and Arg2 must be of data type Text.
Example
Employee@[Last Name] Ends with "son"
Returns TRUE for Employees with a last name such as “Smithson”,
“Johnson” etc.
In
Returns TRUE if a value is contained in a specified list of values.
Syntax
Arg1 In Arg2
Where:
Arg2 is a list of the literals with the same data type as Arg1. It can be of the data type numbers, big decimals, text, date/time, or functions that return these data types.
Examples
•
Employee@[Last Name] in {"Smith", "Cooper", "Michael"}
•
Year in {2000, 2001, 2002}
254
Comparison operators © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Like
Operators 3
Returns TRUE if a text string matches a specified text pattern; otherwise, returns FALSE.
Depending on the wildcards used in the pattern, Like can be used in place of
Begins With, Ends With, Contains, or =. This function is used to search for related strings.
Syntax
Arg1 Like Arg2
Where:
Arg1 and Arg2 must be of data type Text.
Usage notes
•
Wildcards can be used in Arg2 to match any patterns.
•
If there is no wildcard in Arg2, Like is equal to “=”.
•
If the wildcard is in the beginning, Like is equal to “End with”.
•
If the wildcard is in the end, Like is equal to “Begin with”.
•
If there is more than one wildcard, Like is equal to “contain”.
Example
•
Region@DESC like 'South'
Returns TRUE if region is “South”.
•
Region@DESC like 'South%'
Returns TRUE if region is “South”, “SouthEast”, and so on.
•
Region@DESC like '%South%'
Returns TRUE if region is “Mid Southern”, “SouthEast”, “South”, and so on.
© 2012 MicroStrategy, Inc.
Comparison operators
255
3
Operators MicroStrategy Functions Reference
Not begins with
Returns TRUE if a text string does not begin with a specified text pattern.
Syntax
Arg1 Not Begins With Arg2
Where:
Arg1 and Arg2 must be of data type Text.
Example
Region@DESC Not Begins with "South"
Returns TRUE if region is “Northeast”, “North”, and so on.
Not between
Returns TRUE if a specified value does not lie in between two given boundaries.
Syntax
Value Not Between Boundary1 and Boundary2
Where:
Value, Boundary1, and Boundary2 must be of the same data type. They can be of any data type that Microstrategy supports.
Example
Year not between 2000 and 2005
Returns TRUE if Year = 1999
256
Comparison operators © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Operators 3
Not contains
Returns TRUE if a text string does not contain the specified text pattern.
Syntax
Arg1 Not Contains Arg2
Where:
Arg1 and Arg2 must be of Text data type.
Example
Region@DESC Not Contains "South"
Returns TRUE if region is “North”, “West”, and so on.
Not ends with
Returns TRUE if a text string does not end with the specified text pattern.
Syntax
Arg1 Not Ends With Arg2
Where:
Arg1 and Arg2 must be of Text data type.
Example
Region@DESC Not Ends With "East"
Returns TRUE if region is “Northwest”, “West”, and so on.
© 2012 MicroStrategy, Inc.
Comparison operators
257
3
Operators
Not in
MicroStrategy Functions Reference
Returns TRUE if a given value is not in the specified list of values.
Syntax
Arg1 not in Arg2
Where:
Arg2 must be a list with one or more elements. Arg1 must be of the same data type as the elements in Arg2. Arg1 and Arg2 can be of any data type that MicroStrategy supports.
Example
Year not in (2002, 2003)
Returns TRUE if year is 2000, 2001, and so on.
Not like
Returns TRUE if a text string does not match the specified text pattern; otherwise, returns FALSE.
Syntax
Arg1 Not Like Arg2
Where:
Arg1 and Arg2 must be of data type Text.
Example
Region@DESC not like “South%”
Returns TRUE if region is “Northeast”, “North”, “Mid South”, and so on.
258
Comparison operators © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Operators 3
Comparison for rank operators
These functions compare rank values. The Comparison for rank operators are:
•
Less than or equal enhanced (*<=), page 259
•
Not equal enhanced (*<>), page 260
•
•
Greater than or equal enhanced (*>=), page 261
•
Between enhanced (*Between), page 262
•
Not between enhanced (Not *Between), page 263
Less than or equal enhanced (*<=)
Returns TRUE for values in a list which are less than or equal to a specified condition. The list values are generated from the Rank function.
Syntax
ValueList *<= Condition
Where:
•
ValueList is the list of the rank values of a metric.
•
Condition is the value to be compared.
Usage notes
Returns all values in the ValueList that satisfy the condition.
Example
Build a Set Qualification filter with
•
Metric: M1
•
Function: Rank
© 2012 MicroStrategy, Inc.
Comparison for rank operators
259
3
Operators MicroStrategy Functions Reference
•
Operator: *<=
•
Value: 2
Returns TRUE for the values of M1 whose rank values are less than or equal to 2.
Not equal enhanced (*<>)
Returns TRUE for values in a list which are not equal to a specified condition.
The list values are generated from the Rank function.
Syntax
ValueList *<> Condition
Where:
•
ValueList is the list of the rank values of a metric.
•
Condition is the value to be compared.
Usage notes
Returns all values in ValueLists that satisfy the condition.
Example
Build a Set Qualification filter with
•
Metric: M1
•
Function: Rank
•
Operator: *<>
•
Value: 2
Returns TRUE for the values of M1 whose rank values are not equal to 2.
260
Comparison for rank operators © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Operators 3
Equal enhanced (*=)
Returns TRUE for values in a list which are equal to a specified condition. The list values are generated from the Rank function.
Syntax
ValueList *= Condition
Where:
•
ValueList is the list of the rank values of a metric.
•
Condition is the value to be compared.
Example
Build a Set Qualification filter with
•
Metric: M1
•
Function: Rank
•
Operator: *=
•
Value: 2
Returns TRUE for the values of M1 whose rank values are equal to 2.
Greater than or equal enhanced (*>=)
Returns TRUE for values in a list which are greater than or equal to a specified condition. The list values are generated from the Rank function.
Syntax
ValueList *>= Condition
Where:
•
ValueList is the list of the rank values of a metric.
•
Condition is the value to be compared.
© 2012 MicroStrategy, Inc.
Comparison for rank operators
261
3
Operators MicroStrategy Functions Reference
Example
Build a Set Qualification filter with
•
Metric: M1
•
Function: Rank
•
Operator: *>=
•
Value: 2
Return TRUE for the values of M1 whose rank values are greater than or equal to 2.
Between enhanced (*Between)
Returns TRUE for the values in a list of values that are in a specified range.
The values are generated from the Rank function.
Syntax
ValueList *Between Condition1 and Condition2
Where:
•
ValueList is the list of the rank values of a metric.
•
Condition1 and Condition2 set the range of values to be compared.
Usage notes
*Between is inclusive which means any value greater than or equal to
Condition1 and less than or equal to Condition2 will return TRUE.
Example
Build a Set Qualification filter with
•
Metric: M1
•
Function: Rank
•
Operator: *between
262
Comparison for rank operators © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Operators 3
•
Value: 2 and
•
Value: 8
Returns TRUE for the values of M1 whose rank values are between 2 and 8.
Not between enhanced (Not *Between)
Returns TRUE if a list of rank values is not within a specified range. The values are generated from the Rank function.
Syntax
ValueList Not *Between Condition1 and Condition2
Where:
•
ValueList is the list of the rank values of a metric.
•
Condition1 and Condition 2 set the range of values to be compared.
Usage notes
Values equal to Condition1 and Condition2 are not satisfied with the condition.
Example
Build a Set Qualification filter with
•
Metric: M1
•
Function: Rank
•
Operator: *Not between
•
Value: 2 and
•
Value: 8
Return TRUE for the values of M1 whose rank values are less than 2 or greater than 8.
© 2012 MicroStrategy, Inc.
Comparison for rank operators
263
3
Operators MicroStrategy Functions Reference
Logical operators
The logical operators allow certain conditions to be applied to two sets of filter expressions simultaneously.
And
Returns TRUE if both the specified conditions are TRUE; otherwise, returns
FALSE.
Syntax
Arg1 And Arg2
Where:
Arg1 and Arg2 are conditional expressions. The condition can contain metrics, comparison and logical operations, functions, and constants. The condition must be evaluated as TRUE or FALSE.
Example
A condition is defined as:
(Cost < 1000) And (Freight < 500)
This condition will return TRUE only if both, the Cost is less than 1000, and the Freight is less than 500.
IF
Returns a value if the specified condition is TRUE; otherwise, a default value is returned. This is a single value function.
Syntax
IF (Condition, TrueBranch, FalseBranch)
264
Logical operators © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Operators 3
Where:
•
Condition is the conditional expression. The condition can contain metrics, comparison and logical operations, and constants. The condition must be evaluated to be TRUE or FALSE.
•
TrueBranch is a constant or metric value to return if the condition is
TRUE.
•
FalseBranch is a constant or metric value to return if the condition is
FALSE.
Usage notes
FalseBranch must be provided; otherwise the return value is undefined.
Example
A metric is defined as:
IF ((Total Revenue < 300000), 0, 1)
This metric returns 0 if the Total Revenue is less than 300,000; otherwise, it returns 1.
Not
Returns TRUE if the specified condition is FALSE, and FALSE if the condition is TRUE.
Syntax
Not(Arg1)
Where:
Arg1 is the conditional expression. The condition can contain metrics, comparison and logical operations, and constants. The condition must be evaluated as TRUE or FALSE.
Example
A condition is defined as:
Not ((Profit <= 0))
© 2012 MicroStrategy, Inc.
Logical operators
265
3
Operators MicroStrategy Functions Reference
This condition returns TRUE only if the profit is greater than zero.
Or
Returns FALSE if both the specified conditions are FALSE; else returns
TRUE.
Syntax
Arg1 Or Arg2
Where:
Arg1 and Arg2 are conditional expressions. The condition can contain metrics, comparison and logical operations, and constants. The condition must be evaluated as TRUE or FALSE.
Example
A condition is defined as:
(Cost <= 1000) Or (Freight <= 500)
This condition returns FALSE only if the Cost is greater than 1000, and the
Freight is greater than 500.
266
Logical operators © 2012 MicroStrategy, Inc.
4
4.
P
LUG
-I
N
P
ACKAGE
F
UNCTIONS
Introduction
The functions in this chapter represent the more advanced functions available in MicroStrategy, including data mining, financial, mathematical, and statistical functions. For more information on the plug-in functions and how to install the Function Plug-in Wizard, see
Using custom plug-in functions, page 64
Each section briefly describes the category of function and then lists each function along with information designed to provide data necessary for understanding and implementing an individual function. The information provided for each function includes:
•
An explanation of the data returned by the function
•
The syntax of the function including function name, the available parameters, the parameter setting defaults, and the types of data possible for use with the function
•
The mathematical expression illustrating exactly how the calculation is defined in MicroStrategy (if applicable)
•
Usage notes describing any error conditions, invalid data types, or key items to know before using the function (if applicable)
© 2012 MicroStrategy, Inc.
267
4
Plug-In Package Functions MicroStrategy Functions Reference
•
An example of the function in use; this can be either a report example or a simple text description of the data returned based on the specified input
Appendix A, MicroStrategy and Database Support for Functions
for a list of the databases and the functions they support.
The following categories of functions are covered:
•
Data mining functions, page 268
•
•
Mathematical functions, page 323
•
Statistical functions, page 345
Data mining functions
Data mining generally refers to examining a large amount of data to extract valuable information. The data mining process uses predictive models based on existing and historical data to project potential outcome for business activities and transactions. MicroStrategy Data Mining Services facilitates the development and deployment of these predictive models.
Data mining is covered in the Data Mining Services chapter of the
MicroStrategy Advanced Reporting Guide. The Data Mining Services chapter introduces MicroStrategy Data Mining Services, which includes these features:
•
Using MicroStrategy and the Training Metric Wizard to create multi-variable regression predictive models
•
Support for importing third-party predictive models using the PMML industry standard
•
A Predictive Model Viewer that visualizes the predictive model
•
A set of sample predictive metrics and reports incorporated into
Customer Analysis Module (CAM)
In addition, the Data Mining Services chapter of the Advanced Reporting
Guide describes the process of how to create and use predictive models with
MicroStrategy and provides a business case for illustration.
268
Data mining functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
The data mining functions that are available within MicroStrategy are employed when using standard MicroStrategy Data Mining Services interfaces and techniques, which includes the Training Metric Wizard and importing third-party predictive models. To ensure proper functionality, it is recommended to use these MicroStrategy data mining functions within the
Data Mining Services interfaces and techniques, rather than manually defining the values and parameters for these functions.
Financial functions
The financial functions plug-in package in MicroStrategy provides access to many standard financial calculations. All finance-related calculations are performed by the MicroStrategy Analytical Engine, regardless of the database environment.
Accrint (accrued interest)
Accrued interest is interest that has accumulated over a period of time, but has not yet been paid. This function returns the amount of accrued interest on a security that pays periodic interest.
Syntax
Accrint <Par = 1000, Basis> (Issue, FirstInterest,
Settlement, Rate, Frequency)
Where:
•
Issue is the issue date.
•
FirstInterest is the first date on which interest is accrued.
•
Settlement is the settlement date. This is the date, after issue, on which the security is traded.
•
Rate is the annual coupon rate.
•
Par is a parameter that indicates the par value. The default, and only valid value is 1000.
•
Frequency is the number of coupon payments per year. The valid values are, 1, 2, and 4 where annual payments =1, semiannual payments =2, and quarterly payments =4.
© 2012 MicroStrategy, Inc.
Financial functions
269
4
Plug-In Package Functions MicroStrategy Functions Reference
•
Basis is a parameter that indicates the time-count basis to be used. The default value for Basis is 0, which is typically used by American agencies and assumes 30-day months and 360-day years (30/360). Possible values for this parameter are listed in the following table.
Basis value Application
0 (30/360) Assumes 30 days in each month, 360 days in each year.
1 (actual/actual) Assumes actual number of days in each month, actual number of days in each year.
2 (actual/360)
3 (actual/365)
4 (30/60)
Assumes actual number of days in each month, 360 days in each year.
Assumes actual number of days in each month, 365 days in each year.
Used by European agencies, assumes the same values as “0” for American institutions.
Expression
ACCRINT = par
frequency
NC
i = 1 i
NL i
Where:
•
Ai is the number of accrued days for the ith quasi-coupon period within an odd period
•
NC is the number of quasi-coupon periods that fit an odd period (if this period contains a fraction, that fraction is rounded up to the nearest integer)
•
NLi is the normal length, in days, of the ith quasi-coupon period within an odd period
Usage notes
•
If Issue, FirstInterest, Settlement, or Frequency is not an integer, it is truncated
•
The engine returns an empty cell if:
Issue, FirstInterest, or Settlement is not a valid date
Par
1000
Issue Settlement
Frequency is a value other than 1, 2, or 4
270
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
•
The Issue date, the FirstInterest date and the Settlement date should be included within single quotations in the expression for the expression to be considered as a valid expression
Example
This example displays the expression built using Accrint for a treasury bond with the following terms:
•
March 22, 2003, issue date
•
June 20, 2003, first interest date
•
September 16, 2003, settlement date
•
10.0 percent coupon
•
$1,000 par value
•
Frequency is semiannual
•
Basis is 30/360
The accrued interest is defined as:
Accrint <Par=1000, Basis=0> (‘3/22/2003’,’9/16/2003’,’6/
20/2003’,0.1,2) {~+}
Accrintm (accrued interest at maturity)
Accrued interest is interest that has accumulated over a period of time, but has not yet been paid. This function returns the accrued interest amount on a security that pays periodic interest at maturity.
Syntax
Accrintm <Par = 1000, Basis> (Issue, Maturity, Rate)
Where:
•
Issue is the issue date.
•
Maturity is the maturity date. This is the date on which the coupon expires.
•
Rate is the annual coupon rate.
© 2012 MicroStrategy, Inc.
Financial functions
271
4
Plug-In Package Functions MicroStrategy Functions Reference
•
Par is a constant that indicates the par value. The default, and only valid, value is 1000.
•
Basis is a parameter that indicates the time-count basis to be used. The default value for Basis is 0, which is typically used by American agencies and assumes 30-day months and 360-day years (30/360). Possible values for this parameter are listed in the following table.
Basis value Application
0 (30/360) Assumes 30 days in each month, 360 days in each year.
1 (actual/actual) Assumes actual number of days in each month, actual number of days in each year.
2 (actual/360)
3 (actual/365)
4 (30/60)
Assumes actual number of days in each month, 360 days in each year.
Assumes actual number of days in each month, 365 days in each year.
Used by European agencies, assumes the same values as “0” for American institutions.
Expression
ACCRINTM
= par rate
D
Where:
•
A is the accrued time (for interest-at-maturity items, the value used is the number of days from issue to maturity)
•
D is the annual-yield basis
Usage notes
•
If Issue or Maturity is not an integer, it is truncated.
•
The engine returns an empty cell if
Issue or Maturity is not a valid date
Rate
0
Par
1000
•
The Issue date and the Maturity date should be included within single quotations in the expression for the expression to be considered as a valid expression.
272
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Example
This example displays the expression built using the Accrintm function for a note with the following terms:
•
March 22, 2001, issue date
•
June 20, 2003, maturity date
•
10.0 percent coupon
•
$1,000 par value
•
Frequency is semiannual
•
Basis is Actual/365
The accrued interest at maturity is defined as:
Accrintm <Par=1000, Basis=3> (‘3/22/2001’,’6/20/
2001’,0.1){~+}
Coupdaybs (coupon period, beginning to settlement)
Returns the number of days from the beginning of a coupon period to the settlement date.
Syntax
Coupdaybs <Basis> (Settlement, Maturity, Frequency)
Where:
•
Settlement is the settlement date. This is the date, after issue, on which the security is traded.
•
Maturity is the maturity date. This is the date on which the security expires.
•
Frequency is the number of coupon payments per year. The valid values are 1,2 and 4 where annual payments =1, semiannual payments =2, and quarterly payments =4.
•
Basis is a parameter that indicates the time-count basis to be used. The default value for Basis is 0, which is typically used by American agencies
© 2012 MicroStrategy, Inc.
Financial functions
273
4
Plug-In Package Functions MicroStrategy Functions Reference and assumes 30-day months and 360-day years (30/360). Possible values for this parameter are listed in the following table.
Basis value Application
0 (30/360) Assumes 30 days in each month, 360 days in each year.
1 (actual/actual) Assumes actual number of days in each month, actual number of days in each year.
2 (actual/360)
3 (actual/365)
4 (30/60)
Assumes actual number of days in each month, 360 days in each year.
Assumes actual number of days in each month, 365 days in each year.
Used by European agencies, assumes the same values as “0” for American institutions.
Usage notes
•
If an argument is not an integer, it is truncated.
•
The Settlement date and the Maturity date should be included within single quotations in the expression for the expression to be considered as a valid expression.
Coupdays (coupon period, number of days with settlement)
Returns the number of days in the coupon period that contains the settlement date.
Syntax
Coupdays <Basis> (Settlement, Maturity, Frequency)
Where:
•
Settlement is the settlement date. This is the date, after issue, on which the security is traded.
•
Maturity is the maturity date. This is the date on which the security expires.
•
Frequency is the number of coupon payments per year. The valid values are 1, 2, and 4 where annual payments =1, semiannual payments =2, and quarterly payments =4.
•
Basis is a parameter that indicates the time-count basis to be used. The default value for Basis is 0, which is typically used by American agencies
274
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4 and assumes 30-day months and 360-day years (30/360). Possible values for this parameter are listed in the following table.
Basis value Application
0 (30/360) Assumes 30 days in each month, 360 days in each year.
1 (actual/actual) Assumes actual number of days in each month, actual number of days in each year.
2 (actual/360)
3 (actual/365)
4 (30/60)
Assumes actual number of days in each month, 360 days in each year.
Assumes actual number of days in each month, 365 days in each year.
Used by European agencies, assumes the same values as “0” for American institutions.
Usage notes
•
The number of days between milestones is computed depending on the chosen day basis
•
Coupon functions are defined against the maturity day, depending on frequency
•
The Settlement date and the Maturity date should be included within single quotations in the expression for the expression to be considered as a valid expression
Coupdaysnc (coupon period, settlement to next coupon)
Returns the number of days from the settlement date to the next coupon date.
Syntax
Coupdaysnc <Basis = 0> (Settlement, Maturity, Frequency)
Where:
•
Settlement is the settlement date. This is the date, after issue, on which the security is traded.
•
Maturity is the maturity date. This is the date on which the security expires.
© 2012 MicroStrategy, Inc.
Financial functions
275
4
Plug-In Package Functions MicroStrategy Functions Reference
•
Frequency is the number of coupon payments per year. The valid values are 1, 2, and 4 where annual payments =1, semiannual payments =2, and quarterly payments =4.
•
Basis is a parameter that indicates the time-count basis to be used. The default value for Basis is 0, which is typically used by American agencies and assumes 30-day months and 360-day years (30/360). Possible values for this parameter are listed in the following table.
Basis value Application
0 (30/360) Assumes 30 days in each month, 360 days in each year.
1 (actual/actual) Assumes actual number of days in each month, actual number of days in each year.
2 (actual/360)
3 (actual/365)
4 (30/60)
Assumes actual number of days in each month, 360 days in each year.
Assumes actual number of days in each month, 365 days in each year.
Used by European agencies, assumes the same values as “0” for American institutions.
Usage notes
•
If an argument is not an integer, it is truncated.
•
The engine returns an empty cell if
Settlement or Maturity is not a valid date.
Frequency is a number other than 1, 2, or 4.
Settlement
Maturity.
•
The Settlement date and the Maturity date should be included within single quotations in the expression for the expression to be considered as a valid expression.
Coupncd (next date after settlement)
Returns a number that represents the next coupon date after settlement.
Syntax
Coupncd <Basis> (Settlement, Maturity, Frequency)
276
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Where:
•
Settlement is the settlement date. This is the date, after issue, on which the security is traded.
•
Maturity is the maturity date. This is the date on which the security expires.
•
Frequency is the number of coupon payments per year. The valid values are 1, 2, and 4 where annual payments =1, semiannual payments =2, and quarterly payments =4.
•
Basis is a parameter that indicates the time-count basis to be used. The default value for Basis is 0, which is typically used by American agencies and assumes 30-day months and 360-day years (30/360). Possible values for this parameter are listed in the following table.
Basis value Application
0 (30/360) Assumes 30 days in each month, 360 days in each year.
1 (actual/actual) Assumes actual number of days in each month, actual number of days in each year.
2 (actual/360)
3 (actual/365)
4 (30/60)
Assumes actual number of days in each month, 360 days in each year.
Assumes actual number of days in each month, 365 days in each year.
Used by European agencies, assumes the same values as “0” for American institutions.
Usage notes
•
If an argument is not an integer, it is truncated.
•
The engine returns an empty cell if:
Settlement or Maturity is not a valid date.
Frequency is a number other than 1, 2, or 4.
Settlement Maturity.
•
The Settlement date and the Maturity date should be included within single quotations in the expression for the expression to be considered as a valid expression.
© 2012 MicroStrategy, Inc.
Financial functions
277
4
Plug-In Package Functions MicroStrategy Functions Reference
Coupnum (coupon, number payable between settlement and maturity)
Returns the number of coupons payable between the settlement date and maturity date, rounded up to the nearest whole coupon.
Syntax
Coupnum <Basis> (Settlement, Maturity, Frequency)
Where:
•
Settlement is the settlement date. This is the date, after issue, on which the security is traded.
•
Maturity is the maturity date. This is the date on which the security expires.
•
Frequency is the number of coupon payments per year. The valid values are, 1, 2, and 4 where annual payments =1, semiannual payments =2, and quarterly payments =4.
•
Basis is a parameter that indicates the time-count basis to be used. The default value for Basis is 0, which is typically used by American agencies and assumes 30-day months and 360-day years (30/360). Possible values for this parameter are listed in the following table.
Basis value Application
0 (30/360) Assumes 30 days in each month, 360 days in each year.
1 (actual/actual) Assumes actual number of days in each month, actual number of days in each year.
2 (actual/360) Assumes actual number of days in each month, 360 days in each year.
3 (actual/365) Assumes actual number of days in each month, 365 days in each year.
4 (30/60) Used by European agencies, assumes the same values as “0” for American institutions.
Usage notes
•
The number of days between milestones is computed depending on the chosen day basis.
•
Coupon functions are defined against the maturity day, depending on frequency.
278
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
•
The Settlement date and the Maturity date should be included within single quotations in the expression for the expression to be considered as a valid expression.
Couppcd (coupon date, previous)
Returns a number that represents the coupon date before settlement date.
Syntax
Couppcd <Basis> (Settlement, Maturity, Frequency)
Where:
•
Settlement is the settlement date. This is the date, after issue, on which the security is traded.
•
Maturity is the maturity date. This is the date on which the security expires.
•
Frequency is the number of payments per year. The valid values are 1, 2, and 4 where annual payments =1, semiannual payments =2, and quarterly payments =4.
•
Basis is a parameter that indicates the time-count basis to be used. The default value for Basis is 0, which is typically used by American agencies and assumes 30-day months and 360-day years (30/360). Possible values for this parameter are listed in the following table.
Basis value Application
0 (30/360) Assumes 30 days in each month, 360 days in each year.
1 (actual/actual) Assumes actual number of days in each month, actual number of days in each year.
2 (actual/360)
3 (actual/365)
4 (30/60)
Assumes actual number of days in each month, 360 days in each year.
Assumes actual number of days in each month, 365 days in each year.
Used by European agencies, assumes the same values as “0” for American institutions.
Usage notes
•
If an argument is not an integer, it is truncated.
© 2012 MicroStrategy, Inc.
Financial functions
279
4
Plug-In Package Functions MicroStrategy Functions Reference
•
The engine returns an empty cell if:
Settlement or Maturity is not a valid date.
Frequency has a value other than 1, 2, or 4.
Settlement Maturity.
•
The Settlement date and the Maturity date should be included within single quotations in the expression for the expression to be considered as a valid expression.
Cumipmt (cumulative interest paid)
Returns the cumulative interest paid on a loan over a specified period of time.
Syntax
Cumipmt <Type = 0> (Rate, Nper, Pv, Start, End)
Where:
•
Rate is the interest rate.
•
Nper is the total number of payment periods.
•
Pv is the present loan value.
•
Start is the first period in the calculation. Payment period counting begins at 1.
•
End is the last period in the calculation.
•
Type is the timing of the payment.
Usage notes
•
Consistency is important when specifying Rate and Nper:
For monthly payments on a four-year loan at an annual interest rate of 12%, Rate = 12%/12; Nper = 4 × 12.
For annual payments on a four-year loan at an annual interest rate of
12%, Rate = 12%; Nper = 4.
•
If Nper, Start, End, or Type is not an integer, it is truncated.
280
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
•
The engine returns an empty cell if:
Rate
0, Nper
0, or Pv
0
Start < 1 or End < 1
Start > End
Type
0
Example
A home mortgage loan has the following terms:
•
Interest rate: 9.00 percent per annum (rate = 9.00% ÷ 12 = 0.0075)
•
Term: 30 years (nper = 30 × 12 = 360)
•
Present value: $125,000
The total interest paid in the second year of payments (periods 13 through
24) is defined as follows:
CUMIPMT(0.0075,360,125000,13,24) equals -11135.23
The interest paid in a single payment in the first month is defined as follows:
CUMIPMT(0.0075,360,125000,1,1) equals -937.50
Cumprinc (cumulative principal paid)
Returns the cumulative principal paid on a loan over a specified period of time.
Syntax
Cumprinc <Type = 0> (Rate, Nper, Pv, Start, End)
Where:
•
Rate is the interest rate.
•
Nper is the total number of payment periods.
•
Pv is the present loan value.
© 2012 MicroStrategy, Inc.
Financial functions
281
4
Plug-In Package Functions MicroStrategy Functions Reference
•
Start is the first period in the calculation. Payment period counting begins at 1.
•
End is the last period in the calculation.
•
Type is a parameter that indicates the timing of the payment.
Usage notes
•
Consistency is important when specifying Rate and Nper:
For monthly payments on a four-year loan at an annual interest rate of 12%, Rate = 12%/12; Nper = 4 × 12.
For annual payments on a four-year loan at an annual interest rate of
12%, Rate = 12%; Nper = 4.
•
If Nper, Start, End, or Type is not an integer, it is truncated.
•
The engine returns an empty cell if
Rate
0, Nper
0, or Pv
0
Start< 1 or End < 1
Start > End
Type
0
Example
A home mortgage loan has the following terms:
•
Interest rate: 9.00 percent per annum (rate = 9.00% ÷ 12 = 0.0075)
•
Term: 30 years (nper = 30 × 12 = 360)
•
Present value: $125,000
The total principal paid in the second year of payments (periods 13 through
24) is defined as follows:
CUMPRINC(0.0075,360,125000,13,24) equals -934.1071
The principal paid in a single payment in the first month is defined as follows:
CUMPRINC(0.0075,360,125000,1,1) equals -68.27827
282
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Db (fixed-declining balance (asset depreciation))
Returns the depreciation of an asset for a specified period, using the fixed-declining-balance method. This is a method of accelerated depreciation which is faster than straight line depreciation early in the life of the asset.
Syntax
Db <Month> (Cost, Salvage, Life, Period)
Where:
•
Cost is the initial cost of the asset.
•
Salvage is the value of the asset at the end of the depreciation period.
•
Life is the number of periods over which the asset is depreciated. This is sometimes referred to as the useful life of an asset.
•
Period is the period of time over which depreciation is calculated.
•
Month is an integer indicating the number of months in the first year.
Expression
•
To calculate depreciation over any given period:
Where:
Rate = 1
–
•
To calculate depreciation for the first period:
•
To calculate depreciation for the last period:
Cost total depreciation from previous periods
R ate
12
–
M onth
Ddb (double-declining balance (asset depreciation))
Returns the depreciation of an asset for a specified period, using the double-declining-balance method. Double declining balance is a method of accelerated depreciation that is twice as fast as the straight line depreciation method.
© 2012 MicroStrategy, Inc.
Financial functions
283
4
Plug-In Package Functions MicroStrategy Functions Reference
Syntax
Ddb <Factor> (Cost, Salvage, Life, Period)
Where:
•
Cost is the initial cost.
•
Salvage is the cost at the end of depreciation.
•
Life is the number of periods over which depreciation occurs.
•
Period is the period for which depreciation is calculated.
•
Factor is the rate at which the balance declines.
Expression
Usage notes
•
All arguments must be positive values.
•
The double-declining balance method computes depreciation at an accelerated rate: depreciation is highest during the first period and decreases with each succeeding period.
Disc (discount rate for a security)
Returns the discount rate on a security. The discount rate is used to calculate the present value of expected or future benefits and costs.
Syntax
Disc <Basis> (Settlement, Maturity, Price, Redemption)
Where:
•
Settlement is the settlement date. This is the date, after issue, on which the security is traded.
•
Maturity is the maturity date. This is the date on which the security expires.
•
Price is the price per $100 of face value.
•
Redemption is the redemption value per $100 of face value.
284
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
•
Basis is a parameter that indicates the time-count basis to be used. The default value for Basis is 0, which is typically used by American agencies and assumes 30-day months and 360-day years (30/360). Possible values for this parameter are listed in the following table.
Basis value Application
0 (30/360) Assumes 30 days in each month, 360 days in each year.
1 (actual/actual) Assumes actual number of days in each month, actual number of days in each year.
2 (actual/360)
3 (actual/365)
4 (30/60)
Assumes actual number of days in each month, 360 days in each year.
Assumes actual number of days in each month, 365 days in each year.
Used by European agencies, assumes the same values as “0” for American institutions.
Expression
DISC = par
DSM
Where:
•
B is the number of days in a year (see Basis)
•
DSM is the number of days between settlement and maturity
Usage notes
•
If Settlement or Maturity is not an integer, it is truncated.
•
The engine returns an empty cell if
Settlement or Maturity is not a valid date.
Price
0 or Redemption
0.
Settlement
Maturity.
•
The Settlement date and the Maturity date should be included within single quotations in the expression for the expression to be considered as a valid expression.
Dollarde (dollar price, converted from fraction to decimal)
Converts a dollar price expressed as a fraction into a dollar price expressed as a decimal number.
© 2012 MicroStrategy, Inc.
Financial functions
285
4
Plug-In Package Functions
Syntax
Dollarde (FractionalDollar, Decimal)
Expression
Dollarde = INT price
+
–
MicroStrategy Functions Reference
-----------------
Where:
•
price is the dollar value to be converted
•
fraction is the fraction denominator value as an integer
Dollarfr (dollar price, converted from decimal to fraction)
Converts a dollar price expressed as a decimal into a dollar price expressed as a fraction.
Syntax
Dollarfr (DecimalDollar, Fraction)
Where:
•
DecimalDollar is the dollar value to be converted
•
Fraction is the fraction denominator value as an integer
Duration
Returns the Macauley duration for an assumed par value of $100. Duration is the weighted average of the present value of the cash flows and is used as a measure of a bond price’s response to changes in yield. Bonds with higher durations face higher risk from changes in interest rates.
Syntax
Duration <Basis> (Settlement, Maturity, CouponRate,
YieldRate, Frequency)
286
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Where:
•
Settlement is the settlement date. This is the date, after issue, on which the security is traded.
•
Maturity is the maturity date. This is the date on which the security expires.
•
CouponRate is the annual interest rate of the coupon.
•
YieldRate is the annual yield.
•
Frequency is the number of coupon payments per year. The valid values are 1, 2, and 4 where annual payments =1, semiannual payments =2, and quarterly payments =4.
•
Basis is a parameter that indicates the time-count basis to be used. The default value for Basis is 0, which is typically used by American agencies and assumes 30-day months and 360-day years (30/360). Possible values for this parameter are listed in the following table.
Basis value Application
0 (30/360) Assumes 30 days in each month, 360 days in each year.
1 (actual/actual) Assumes actual number of days in each month, actual number of days in each year.
2 (actual/360)
3 (actual/365)
4 (30/60)
Assumes actual number of days in each month, 360 days in each year.
Assumes actual number of days in each month, 365 days in each year.
Used by European agencies, assumes the same values as “0” for American institutions.
Expression
=
1 + -------------------
N 1 +
E
+
N
k = 1
------------------------------------------------------------------------
+ ------
frequency
1 +
+
E
--------------------------------------------------------------------------------------------------------------------------------------------------------------------
N
N 1 +
+
E k = 1
------------------------------------------------------------------------
+ ------
1 + -------------------
frequency
1 +
© 2012 MicroStrategy, Inc.
Financial functions
287
4
Plug-In Package Functions MicroStrategy Functions Reference
Where:
•
DSC is the number of days from settlement to next coupon date
•
E is the number of days in settlement’s coupon period
•
N is the number of coupons from settlement to maturity
Usage notes
The Settlement date and the Maturity date should be included within single quotations in the expression for the expression to be considered as a valid expression.
Effect (effective annual interest rate)
Returns the effective annual interest rate on a given amount. This is the actual annual rate or yield on a loan.
Syntax
Effect(NominalRate, Npery)
Where:
•
NominalRate is the nominal interest rate.
•
Npery is the number of compounding periods per year.
Expression
Effect =
Npery
–
1
Usage notes
•
If Npery is not an integer, it is truncated.
•
The engine returns an empty cell if
Either argument is nonnumeric.
NominalRate
0.
Npery <= 1.
288
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Fv (future value)
Returns the future value of an investment based on periodic, constant payments and a constant interest rate. The future value is equal to the present value plus the amount of accumulated interest that would be earned.
This can be applied to future payments, with interest calculated for each payment.
Syntax
Fv <Type> (Rate, Nper, Pmt, Pv)
Where:
•
Rate is the interest rate per period.
•
Nper is the total number of payment periods.
•
Pmt is the (fixed) amount paid each period. This typically includes principal and interest, but no other fees or taxes.
•
Pv is the present value (lump-sum amount) of future payments. If no value is provided, it is assumed to be 0 (zero).
•
Type is a parameter that indicates when payments are due.
Usage notes
•
In all cases, disbursements, such as deposits, are represented by negative numbers; funds received, such as dividends, are represented by positive numbers.
•
Use the Fvschedule function for payments made with a variable or adjustable interest rate.
Fvschedule (future value schedule)
Returns the future value of an initial principal after a series of compound-interest rates are applied. Use this function to calculate the future value of an investment that has a variable or adjustable rate.
Syntax
Fvschedule <Basis> (Argument, PV)
© 2012 MicroStrategy, Inc.
Financial functions
289
4
Plug-In Package Functions MicroStrategy Functions Reference
Where:
•
Argument is a set of applicable interest rates.
•
PV is the present value of the investment.
•
Basis is a parameter that indicates the time-count basis to be used. The default value for Basis is 0, which is typically used by American agencies and assumes 30-day months and 360-day years (30/360). Possible values for this parameter are listed in the following table.
Basis value Application
0 (30/360) Assumes 30 days in each month, 360 days in each year.
1 (actual/actual) Assumes actual number of days in each month, actual number of days in each year.
2 (actual/360)
3 (actual/365)
4 (30/60)
Assumes actual number of days in each month, 360 days in each year.
Assumes actual number of days in each month, 365 days in each year.
Used by European agencies, assumes the same values as “0” for American institutions.
Usage notes
•
If Argument is nonnumeric, the engine returns an empty cell.
•
Use the Fv function for payments made with a constant interest rate.
Intrate (interest rate)
Returns the interest rate for a fully invested security. The interest rate is the percentage value that is multiplied by the principal to determine the amount of interest due or paid in a given period of time.
Syntax
Intrate <Basis> (Settlement, Maturity, Investment,
Redemption)
Where:
•
Settlement is the settlement date. This is the date, after issue, on which the security is traded.
•
Maturity is the maturity date. This is the date on which the security expires.
290
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
•
Investment is the amount invested in the security.
•
Redemption is the amount actually received for the security.
•
Basis is a parameter that indicates the time-count basis to be used. The default value for Basis is 0, which is typically used by American agencies and assumes 30-day months and 360-day years (30/360). Possible values for this parameter are listed in the following table.
Basis value Application
0 (30/360) Assumes 30 days in each month, 360 days in each year.
1 (actual/actual) Assumes actual number of days in each month, actual number of days in each year.
2 (actual/360)
3 (actual/365)
4 (30/60)
Assumes actual number of days in each month, 360 days in each year.
Assumes actual number of days in each month, 365 days in each year.
Used by European agencies, assumes the same values as “0” for American institutions.
Expression
Intrate = investment
------
Where:
•
Redemption is the amount actually received for the security
•
Investment is the amount invested in the security
•
B is the number of days in a year, depending on year basis
•
DIM is the number of days from settlement to maturity
Usage notes
The Settlement date and the Maturity date should be included within single quotations in the expression for the expression to be considered as a valid expression.
Ipmt (interest payment)
Returns the interest payment for a given period, based on periodic, constant payments and a constant interest rate.
© 2012 MicroStrategy, Inc.
Financial functions
291
4
Plug-In Package Functions MicroStrategy Functions Reference
Syntax
Ipmt < FV, Type> (Rate, Period, Nperiod, PV)
Where:
•
Rate is the interest rate per period.
•
Period is the period for which the interest payment is sought. The valid range is from 1 to Nperiod.
•
Nperiod is the total number of payment periods.
•
PV is the present value. This is the total value that a series of future payments has today.
•
FV is a parameter that indicates the future value, also called the cash
balance, expected after the last payment is made.
•
Type is a parameter that indicates when payments are due.
Usage notes
•
For this function, consistency in the units used is necessary:
Assuming monthly payments on a four-year loan at 12% annual interest, Nperiod should be 4 × 12.
Assuming annual payments on a four-year loan at 12% annual interest, Nperiod should be 4.
•
For this function, disbursements (such as deposits to savings) are represented by negative numbers; funds received (such as dividend checks) are represented by positive numbers.
IRR (internal rate of return)
Returns the internal rate of return on a set of payments. The internal rate of return is the interest rate received for an investment consisting of payments that occur periodically. These payments do not need to be equal in value, but they must occur at regular intervals, such as monthly, quarterly, or annually.
Syntax
IRR <FactID, Guess, METHOD, Precision, SortBy>
(Argument)
292
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Where:
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
•
Guess is a parameter that indicates an estimate assumed to be close to the result sought. The default value is 0.1, which can be thought of as representing an expected internal rate of return of 10 percent.
•
Method is a parameter that determines the algorithm used to calculate the IRR function. You can use the following values:
0 (default): The IRR function uses the secant method to determine the internal rate of return. This is the recommended method as it can adjust the initial guess as required to return a result.
1: The IRR function uses Newton’s method to determine the internal rate of return. This method can return results similar to those returned for internal rate of return functions that are supplied with
Microsoft Excel.
•
Precision is a parameter that determines how close the evaluation of a potential solution must be to zero to be considered valid.
•
Argument is a fact or metric representing a list of numbers for which the internal rate of return is sought.
•
SortBy is a parameter that defines the order of calculation. For more
BreakBy and SortBy parameters, page 19
.
Usage notes
•
The list of values must contain at least one positive entry and one negative entry.
•
Payments, whether positive or negative, must be entered in the desired sequence, as this is the order in which entries are interpreted for calculation.
Mduration (modified duration)
Returns the modified Macauley duration, which is the weighted average of present payments, for a security with an assumed par value of $100. This function is used as a measure of bond-price response to variations in yield.
© 2012 MicroStrategy, Inc.
Financial functions
293
4
Plug-In Package Functions MicroStrategy Functions Reference
Syntax
Mduration <Basis> (Settlement, Maturity, CouponRate,
YieldRate, Frequency)
Where:
•
Settlement is the settlement date. This is the date, after issue, on which the security is traded.
•
Maturity is the date of maturity. This is the date on which the security expires.
•
CouponRate is the annual interest rate of the coupon.
•
YieldRate is the annual yield.
•
Frequency is the number of coupon payments per year. The valid values are 1, 2, and 4 where annual payments =1, semiannual payments =2, and quarterly payments =4.
•
Basis is a parameter that indicates the time-count basis used. The default value for Basis is 0, which is typically used by American agencies and assumes 30-day months and 360-day years (30/360). Possible values for this parameter are listed in the following table.
Basis value Application
0 (30/360) Assumes 30 days in each month, 360 days in each year.
1 (actual/actual) Assumes actual number of days in each month, actual number of days in each year.
2 (actual/360)
3 (actual/365)
4 (30/60)
Assumes actual number of days in each month, 360 days in each year.
Assumes actual number of days in each month, 365 days in each year.
Used by European agencies, assumes the same values as “0” for American institutions.
Expression
Mduration =
1 +
-------------------
Where:
•
yld is the security annual yield
•
frequency is the number of coupon payments per year
294
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Usage notes
•
If Settlement, Maturity, or Frequency is not an integer, it is truncated.
•
The engine returns an empty cell if:
Either Settlement or Maturity is not a valid date.
CouponRate < 0.
YieldRate < 0.
Frequency is a number other than 1, 2, or 4.
Settlement
Maturity.
•
The Settlement date and the Maturity date should be included within single quotations in the expression for the expression to be considered as a valid expression.
MIRR (modified internal rate of return)
Returns the modified internal rate of return on a set of periodic payments.
This function takes into consideration both the cost of investment and the interest received on investment.
Syntax
MIRR <FactID> (Argument, FinancialRate, ReinvestRate)
Where:
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
•
Argument is a list of values containing a set of numbers. Entries in this list can represent payments (negative values) or income (positive values) occurring at regular intervals.
•
FinancialRate is the interest rate paid.
•
ReinvestRate is the interest rate received on reinvested funds.
© 2012 MicroStrategy, Inc.
Financial functions
295
4
Plug-In Package Functions MicroStrategy Functions Reference
Expression
,
1 rrate
+
n
–
1
Usage notes
•
If Argument does not contain at least one positive entry (income) and one negative entry (payments), the engine returns an empty cell.
•
In calculating the return for this function, the order in which entries are provided is assumed to be the order in which funds flow; it is important, therefore, that payments and income be entered in the correct sequence.
Nominal (nominal annual interest rate)
Returns the nominal annual interest rate on an investment, based on the effective rate and the number of compounding periods per year. This is the interest rate that is not adjusted for actual or expected inflation.
Syntax
Nominal(EffectiveRate, Npery)
Where:
•
EffectiveRate is the effective interest rate.
•
Npery is the number of compounding periods per year.
Expression
Nominal =
Npery
–
1
Usage notes
•
If Npery is not an integer, it is truncated.
•
The engine returns an empty cell if
Either argument is nonnumeric.
EffectiveRate
0.
Npery < 1.
296
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Nper (number of investment periods)
Returns the number of periods for an investment, based on periodic, constant payments and a constant interest rate.
Syntax
Nper <Type> (Rate, Pmt, PV, FV)
Where:
•
Rate is the internal rate for each period.
•
Pmt is the amount paid each period. Typically it includes principal and interest, but no other fees or taxes.
•
PV is the present value of a series of future payments. If this value is omitted, is assumed to be 0 (zero).
•
FV is the value that remains after the last payment is made.
•
Type is a number that indicates when payments are due.
NPV (net present value of an investment)
Returns the net present value of an investment based on a discount rate and a set of future payments (negative values) and income (positive values).
Syntax
NPV <FactID, SortBy> (Argument, Rate)
Where:
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
•
SortBy is a parameter that defines the order of calculation. For more
BreakBy and SortBy parameters, page 19
.
•
Argument is a fact or metric representing a list of values containing either payment or income figures.
•
Rate is the discount rate for the length of a period.
© 2012 MicroStrategy, Inc.
Financial functions
297
4
Plug-In Package Functions
Expression
MicroStrategy Functions Reference
NPV = n
i = 1
------------------
i
Where:
•
n is the number of entries in Values
Usage notes
•
All entries in Values must be equally spaced in time, and occur at the end of each period.
•
The order of the entries in Values is assumed to be the order in which funds flow; payment and income entries must, therefore, be provided in the correct sequence.
•
Investment begins one period before the date on which the first entry in
Values occurs, and ends with the last entry in that array.
•
If the first entry in Values occurs at the beginning of a period, it must be added to the result of the function.
•
The primary differences between this function and the Present Value
(PV) function are that
PV allows fund flow to occur either at the beginning or at the end of a period.
PV fund-flow occurrences must be constant across the life of the investment.
298
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Oddfprice (odd-first-period price)
Returns the price per $100 face value of a security having an odd (short or long) first period.
Syntax
Oddfprice <Basis> (Settlement, Maturity, Issue,
FirstCoupon, CouponRate, YieldRate, Redemption,
Frequency)
Where:
•
Settlement is the settlement date. This is the date, after issue, on which the security is traded.
•
Maturity is the date of maturity. This is the date on which the security expires.
•
Issue is the issue date.
•
FirstCoupon is the first-coupon date.
•
CouponRate is the annual interest rate of the coupon.
•
YieldRate is the annual yield.
•
Redemption is the redemption value per $100 of face value.
•
Frequency is the number of coupon payments per year. The valid values are 1, 2, and 4 where annual payments =1, semiannual payments =2, and quarterly payments =4.
•
Basis is a parameter that indicates the time-count basis used. The default value for Basis is 0, which is typically used by American agencies and assumes 30-day months and 360-day years (30/360). Possible values for this parameter are listed in the following table.
Basis value Application
0 (30/360) Assumes 30 days in each month, 360 days in each year.
1 (actual/actual) Assumes actual number of days in each month, actual number of days in each year.
2 (actual/360) Assumes actual number of days in each month, 360 days in each year.
3 (actual/365) Assumes actual number of days in each month, 365 days in each year.
4 (30/60) Used by European agencies, assumes the same values as “0” for American institutions.
© 2012 MicroStrategy, Inc.
Financial functions
299
4
Plug-In Package Functions MicroStrategy Functions Reference
Expression
There are two expressions for this function:
•
Odd Short First Coupon: for securities with a short first period
•
Odd Long First Coupon: for securities with a long first period
Odd Short First Coupon
=
1 + -------------------
N 1 +
E
+
100
E
E
1 + -------------------
+
N k = 2
100
-------------------------------------------------
+
E
1 + -------------------
– 100
E
Where:
•
A is the number of days from beginning of coupon period to settlement date (accrued days)
•
DSC is the number of days from settlement to next coupon date
•
DFC is the number of days from the beginning of odd first coupon to first coupon date
•
E is the number of days in coupon period
•
N is the number of coupons payable between settlement date and redemption date; if this number contains a fraction, it is raised to the next whole number
Odd Long First Coupon
=
1 + yld frequency
+ ------
E
+
100
1 +
NC
------------------frequency yld
-
i
Nq
=
+
1
------
E
+
N
k = 2
100
-------------------
---------------------------------------------------
1 + -------------------
k N q
+ ------
E
– 100
NC
i = 1
NLi
Where:
•
Ai is the number of days from beginning of the ith quasi-coupon period within odd period
•
DCi is the Number of days from date to first quasi-coupon (i=1) or number of days in quasi-coupons (i=2,..., i=NC)
•
DSC is the Number of days from settlement to next coupon date
300
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
•
E is the Number of days in coupon period
•
N is the Number of coupons payable between the first real coupon date and redemption date; if this number contains a fraction, it is raised to the next whole number
•
NC is the Number of quasi-coupon periods that fit in odd period; if this number contains a fraction it is raised to the next whole number
•
NLi is the Normal length in days of the full ith quasi-coupon period within odd period
•
Nq is the Number of whole quasi-coupon periods between settlement date and first coupon
Usage notes
The Settlement date and the Maturity date should be included within single quotations in the expression for the expression to be considered as a valid expression.
Oddfyield (odd-first-period yield)
Returns the yield of a security that has an odd (short or long) first period.
Syntax
Oddfyield <Basis> (Settlement, Maturity, Issue,
FirstCoupon, CouponRate, Price, Redemption, Frequency)
Where:
•
Settlement is the settlement date. This is the date, after issue, on which the security is traded.
•
Maturity is the maturity date. This is the date on which the security expires.
•
Issue is the issue date.
•
FirstCoupon is the first coupon date.
•
CouponRate is the annual interest rate of the coupon.
•
Price is the price.
•
Redemption is the redemption value per $100 of face value.
© 2012 MicroStrategy, Inc.
Financial functions
301
4
Plug-In Package Functions MicroStrategy Functions Reference
•
Frequency is the number of payments per year. The valid values are 1, 2, and 4 where annual payments =1, semiannual payments =2, and quarterly payments =4.
•
Basis is a parameter that indicates the time-count basis to be used. The default value for Basis is 0, which is typically used by American agencies and assumes 30-day months and 360-day years (30/360). Possible values for this parameter are listed in the following table.
Basis value Application
0 (30/360) Assumes 30 days in each month, 360 days in each year.
1 (actual/actual) Assumes actual number of days in each month, actual number of days in each year.
2 (actual/360)
3 (actual/365)
4 (30/60)
Assumes actual number of days in each month, 360 days in each year.
Assumes actual number of days in each month, 365 days in each year.
Used by European agencies, assumes the same values as “0” for American institutions.
Usage notes
•
If Settlement, Maturity, Issue, or FirstCoupon is not an integer, it is truncated.
•
The engine returns an empty cell if:
Settlement, Maturity, Issue, or FirstCoupon is not a valid date
CouponRate < 0
Price
0
The following date-related condition is not satisfied: Maturity >
FirstCoupon > Settlement > Issue
•
The Settlement date and the Maturity date should be included within single quotations in the expression for the expression to be considered as a valid expression.
Oddlprice (odd-last-period price)
Returns the price per $100 face value of a security having an odd (short or long) last period.
302
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Syntax
Oddlprice <Basis> (Settlement, Maturity, LastInterest,
CouponRate, YieldRate, Redemption, Frequency)
Where:
•
Settlement is the settlement date. This is the date, after issue, on which the security is traded.
•
Maturity is the maturity date. This is the date on which the security expires.
•
LastInterest is the last date on which interest is accrued.
•
CouponRate is the annual interest rate of the coupon.
•
YieldRate is the annual yield.
•
Redemption is the redemption value per $100 of face value.
•
Frequency is the number of payments per year. The valid values are 1, 2, and 4 where annual payments =1, semiannual payments =2, and quarterly payments =4.
•
Basis is a parameter that indicates the time-count basis to be used. The default value for Basis is 0, which is typically used by American agencies and assumes 30-day months and 360-day years (30/360). Possible values for this parameter are listed in the following table.
Basis value Application
0 (30/360) Assumes 30 days in each month, 360 days in each year.
1 (actual/actual) Assumes actual number of days in each month, actual number of days in each year.
2 (actual/360)
3 (actual/365)
4 (30/60)
Assumes actual number of days in each month, 360 days in each year.
Assumes actual number of days in each month, 365 days in each year.
Used by European agencies, assumes the same values as “0” for American institutions.
Expression
= redemption
+
NC
DCi
NLi
frequency
-------------------------------------------------------------------------------------------------------------------------------
NC i =
1
1
+
i = 1
frequency
–
NC
i = 1
NLi
frequency
© 2012 MicroStrategy, Inc.
Financial functions
303
4
Plug-In Package Functions MicroStrategy Functions Reference
Where:
•
Ai is the Number of accrued days for the ith quasi-coupon period within odd period counting forward from last interest date before redemption
•
DCi
is the Number of days counted in each ith quasi-coupon period as delimited by the length of the actual coupon period
•
NC is the Number of quasi-coupon periods that fit in odd period; if this number contains a fraction, it is raised to the next whole number
•
NLi is the Normal length in days of the ith quasi-coupon period within odd coupon period
•
DSCi is the Number of days from settlement (or beginning of quasi-coupon period) to next quasi coupon within odd period (or to maturity date) for each ith quasi-coupon period.
Usage notes
The Settlement date and the Maturity date should be included within single quotations in the expression for the expression to be considered as a valid expression.
Oddlyield (odd-last-period yield)
Returns the yield of a security that has an odd (short or long) last period.
Syntax
Oddlyield <Basis> (Settlement, Maturity, LastInterest,
CouponRate, Price, Redemption, Frequency)
Where:
•
Settlement is the settlement date. This is the date, after issue, on which the security is traded.
•
Maturity is the maturity date. This is the date on which the security expires.
•
LastInterest is the security’s last coupon date.
•
CouponRate is the interest rate.
•
Price is the price.
304
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
•
Redemption is the redemption value per $100 of face value.
•
Frequency is the number of payments per year. The valid values are 1, 2, and 4 where annual payments =1, semiannual payments =2, and quarterly payments =4.
•
Basis is a parameter that indicates the time-count basis to be used. The default value for Basis is 0, which is typically used by American agencies and assumes 30-day months and 360-day years (30/360). Possible values for this parameter are listed in the following table.
Basis value Application
0 (30/360) Assumes 30 days in each month, 360 days in each year.
1 (actual/actual) Assumes actual number of days in each month, actual number of days in each year.
2 (actual/360)
3 (actual/365)
4 (30/60)
Assumes actual number of days in each month, 360 days in each year.
Assumes actual number of days in each month, 365 days in each year.
Used by European agencies, assumes the same values as “0” for American institutions.
Expression
ODDLYIELD =
redemption +
NC
i = 1
DCi
NLi
100 rate
frequency
par +
i = 1
NLi
–
par +
NC
i = 1
Ai
NLi
100 rate frequency
100 rate
frequency
NC
i = 1
NLi
Where:
•
Ai is the number of accrued days for the ith, or last, quasi-coupon period within odd period counting forward from last interest date before redemption.
•
DCi is the number of days counted in the ith, or last, quasi-coupon period as delimited by the length of the actual coupon period.
•
NC is the number of quasi-coupon periods that fit in odd period; if this number contains a fraction, it is raised to the next whole number.
•
NLi is the normal length in days of the ith, or last, quasi-coupon period within odd coupon period.
© 2012 MicroStrategy, Inc.
Financial functions
305
4
Plug-In Package Functions MicroStrategy Functions Reference
Usage notes
The date arguments should be included within single quotations for the expression to be considered as a valid expression.
Pmt (payment)
Returns the payment cost on a loan, based on constant payments and a constant interest rate.
Syntax
Pmt <FV, Type> (Rate, Nper, PV)
Where:
•
FV a parameter that indicates the future value of the loan. It is the balance to be attained once all payments are made.
•
Type is parameter that indicates when payment is due.
•
Rate is the interest rate.
•
Nper is the number of payments.
•
PV is the present value of the loan, also referred to as principal. This is the current value of a set of future payments.
Usage notes
•
Values returned by this function include principal and interest; they do not include taxes, reserve payments, or ancillary fees.
•
Units must be used consistently when calculating payment. For example:
To calculate monthly payments on a four-year loan at 12% annual interest, Rate should be 12%/12, Nper should be 4 × 12.
To calculate annual payments on the same loan, Rate should be 12%,
Nper should be 4.
•
This function can also be used to determine payments on annuities other than loans.
306
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Ppmt (principal payment)
Returns the payment on the principal for an investment for one given period.
Syntax
Ppmt <Type = 0> (Rate, Per, Nper, PV, FV)
Where:
•
Type is a parameter that indicates when payment is due.
•
Rate is the interest rate.
•
Per is the period desired.
•
Nper is the number of payments.
•
PV is the present value of the loan.
•
FV is the future value of the loan.
Expression
PPMT i
=
– i
Where:
•
i is the period desired
Price (price per $100 face value)
Returns the price, per $100 face value, on a security that pays periodic interest.
Syntax
Price <Basis> (Settlement, Maturity, CouponRate,
YieldRate, Redemption, Frequency)
Where:
•
Settlement is the settlement date. This is the date, after issue, on which the security is traded.
•
Maturity is the maturity date. This is the date on which the security expires.
© 2012 MicroStrategy, Inc.
Financial functions
307
4
Plug-In Package Functions MicroStrategy Functions Reference
•
CouponRate is the annual interest rate.
•
YieldRate is the annual yield.
•
Redemption is the redemption value per $100 of face value.
•
Frequency is the number of payments per year. The valid values are 1, 2, and 4 where annual payments =1, semiannual payments =2, and quarterly payments =4
•
Basis is a parameter that indicates the time-count basis to be used. The default value for Basis is 0, which is typically used by American agencies and assumes 30-day months and 360-day years (30/360). Possible values for this parameter are listed in the following table.
Basis value Application
0 (30/360) Assumes 30 days in each month, 360 days in each year.
1 (actual/actual) Assumes actual number of days in each month, actual number of days in each year.
2 (actual/360)
3 (actual/365)
4 (30/60)
Assumes actual number of days in each month, 360 days in each year.
Assumes actual number of days in each month, 365 days in each year.
Used by European agencies, assumes the same values as “0” for American institutions.
Expression
PRICE =
1 + -------------------
N 1 +
E
+
N
k = 1
100
-------------------------------------------------
k
– 1 +
E
1 + -------------------
–
100
E
Where:
•
DSC is the number of days from settlement to next coupon date
•
E is the number of days in the coupon period in which the settlement date falls
•
N is the number of coupons payable between the settlement date and the redemption date
•
A is the number of days from the beginning of the coupon period to settlement date
Usage notes
•
If Settlement, Maturity, or Frequency is not an integer, it is truncated.
308
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
•
The engine returns an empty cell if:
Settlement or Maturity is not a valid date
CouponRate < 0 or YieldRate < 0
Redemption
0
Frequency has a value other than 1, 2, or 4
Settlement
Maturity
•
The Settlement date and the Maturity date should be included within single quotations in the expression for the expression to be considered as a valid expression.
Pricedisc (price, discounted)
Returns the price, per $100 face value, on a discounted security.
Syntax
Pricedisc <Basis> (Settlement, Maturity, DiscRate,
Redemption)
Where:
•
Settlement is the settlement date. This is the date, after issue, on which the security is traded.
•
Maturity is the maturity date. This is the date on which the security expires.
•
DiscRate is the discount rate.
•
Redemption is the redemption value per $100 of face value.
•
Basis is a parameter that indicates the time-count basis to be used. The default value for Basis is 0, which is typically used by American agencies and assumes 30-day months and 360-day years (30/360). Possible values for this parameter are listed in the following table.
Basis value Application
0 (30/360) Assumes 30 days in each month, 360 days in each year.
1 (actual/actual) Assumes actual number of days in each month, actual number of days in each year.
© 2012 MicroStrategy, Inc.
Financial functions
309
4
Plug-In Package Functions MicroStrategy Functions Reference
Basis value
2 (actual/360)
3 (actual/365)
4 (30/60)
Application
Assumes actual number of days in each month, 360 days in each year.
Assumes actual number of days in each month, 365 days in each year.
Used by European agencies, assumes the same values as “0” for American institutions.
Expression
PRICEDISC =
–
B
Where:
•
B is the number of days in a year (see Basis)
•
DSM is the number of days from settlement to maturity
Usage notes
•
If Settlement or Maturity is not an integer, it is truncated.
•
The engine returns an empty cell if:
Settlement or Maturity is not a valid date.
DiscRate 0 or Redemption 0.
Settlement Maturity.
•
The Settlement date and the Maturity date should be included within single quotations in the expression for the expression to be considered as a valid expression.
Pricemat (price at maturity)
Returns the price, per $100 of face value, on a security that pays interest at maturity.
Syntax
Pricemat <Basis> (Settlement, Maturity, Issue,
CouponRate, YieldRate)
310
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Where:
•
Settlement is the settlement date. This is the date, after issue, on which the security is traded.
•
Maturity is the maturity date. This is the date on which the security expires.
•
Issue is the issue date. It is expressed as a serial date.
•
CouponRate is the interest rate on the date of issue.
•
YieldRate is the annual yield.
•
Basis is a parameter that indicates the time-count basis to be used. The default value for Basis is 0, which is typically used by American agencies and assumes 30-day months and 360-day years (30/360). Possible values for this parameter are listed in the following table.
Basis value Application
0 (30/360) Assumes 30 days in each month, 360 days in each year.
1 (actual/actual) Assumes actual number of days in each month, actual number of days in each year.
2 (actual/360)
3 (actual/365)
4 (30/60)
Assumes actual number of days in each month, 360 days in each year.
Assumes actual number of days in each month, 365 days in each year.
Used by European agencies, assumes the same values as “0” for American institutions.
Expression
PRICEMAT =
100 +
------ rate 100
–
1
+
B
B
Where:
•
B is the number of days in a year (see Basis)
•
DSM is the number of days from settlement to maturity
•
DIM is the number of days from issue to maturity
•
A is the number of days from issue to settlement
© 2012 MicroStrategy, Inc.
Financial functions
311
4
Plug-In Package Functions MicroStrategy Functions Reference
Usage notes
•
If Settlement, Maturity, or Issue is not an integer, it is truncated.
•
The engine returns an empty cell if
Settlement, Maturity, or Issue is not a valid date.
Rate < 0 or Yield < 0.
Settlement
Maturity.
•
The Settlement date, the Maturity date, and the Issue date should be included within single quotations in the expression for the expression to be considered as a valid expression.
Pv (present value)
Returns the present value of an investment.
Syntax
Pv <Type> (Rate, Nper, Pmt, FV)
Where:
•
Type is a value that indicates when payment is due.
•
Rate is the interest rate.
•
Nper is the number of payments.
•
Pmt is the periodic payment for an annuity.
•
FV is the future value of the loan.
Expression
If rate = 0
+
Else pv
nper
+ pmt
+
= 0
type
rate
+ fv = 0
312
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Rate (interest rate per period)
Returns the interest rate per period on a given annuity.
Syntax
Rate <FV, Type, Guess> (Nperiod, Payment, PV)
Where:
•
FV is the future value (also called cash balance) expected after the last payment.
•
Type indicates when payments are due.
•
Guess is an estimate assumed to be close to the result sought.
•
Nperiod is the total number of payment periods.
•
Payment is the payment made for each period. Cannot change over the life of the annuity. Typically, includes principal and interest, but no other fees or taxes.
•
PV is the present value of the annuity. It is the total amount that a series of future payments is worth today.
Usage notes
•
For this function, consistency in the units used is necessary:
Assuming monthly payments on a four-year loan at 12% annual interest, Nperiod should be 4 × 12.
Assuming annual payments on a four-year loan at 12% annual interest, Nperiod should be 4.
Received (amount received at maturity)
Returns the amount received at maturity on a fully invested security.
Syntax
Received <Basis> (Settlement, Maturity, Investment,
Discount)
© 2012 MicroStrategy, Inc.
Financial functions
313
4
Plug-In Package Functions MicroStrategy Functions Reference
Where:
•
Settlement is the settlement date. This is the date, after issue, on which the security is traded.
•
Maturity is the date of maturity. This is the date on which the security expires.
•
Investment is the amount invested.
•
Discount is the discount rate.
•
Basis is a parameter that indicates the time-count basis to be used. The default value for Basis is 0, which is typically used by American agencies and assumes 30-day months and 360-day years (30/360). Possible values for this parameter are listed in the following table.
Basis value Application
0 (30/360) Assumes 30 days in each month, 360 days in each year.
1 (actual/actual) Assumes actual number of days in each month, actual number of days in each year.
2 (actual/360)
3 (actual/365)
4 (30/60)
Assumes actual number of days in each month, 360 days in each year.
Assumes actual number of days in each month, 365 days in each year.
Used by European agencies, assumes the same values as “0” for American institutions.
Expression
RECEIVED =
1
–
discount
B
Where:
•
B is the number of days in a year (see Basis)
•
DIM is the number of days between settlement to maturity
Usage notes
•
If Settlement or Maturity is not an integer, it is truncated.
•
The engine returns an empty cell if
Settlement or Maturity is not a valid date.
Investment
0.
314
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Discount
0.
Maturity
Settlement.
•
The Settlement date and the Maturity date should be included within single quotations in the expression for the expression to be considered as a valid expression.
Sln (straight-line depreciation)
Returns the straight-line depreciation of an asset over a given period. This is the simplest method of depreciation and represents an equal amount charged for each period during the useful life of the asset after allowing for a salvage value.
Syntax
Sln(Cost, Salvage, Life)
Where:
•
Cost is the initial cost of the asset.
•
Salvage, also called the salvaged value of an asset, is the residual value at the end of the estimated life span.
•
Life, also called the useful life of an asset, is the number of periods over which the asset is being depreciated.
Syd (sum of year’s digits depreciation)
Returns the sum of year’s digits depreciation of an asset over a specified period. This method of accelerated depreciation results in higher depreciation early in the life of an asset. It calculates the depreciation for each year on an inverted scale in proportion to the total of all the digits for the asset’s useful life.
Syntax
Syd < > (Cost, Salvage, Life, Period)
Where:
•
Cost is the initial cost.
© 2012 MicroStrategy, Inc.
Financial functions
315
4
Plug-In Package Functions MicroStrategy Functions Reference
•
Salvage, also called the salvaged value of an asset, is the residual value at the end of the estimated life span.
•
Life, also called the useful life of an asset, is the number of periods over which the asset is being depreciated.
•
Period is the depreciation period. This must have the same number of units as Life.
Expression
SYD
=
life
life per
+
+ 1
Tbilleq (T-bill equity)
Returns the bond-equivalent yield of a Treasury bill.
Syntax
Tbilleq(Settlement, Maturity, Discount)
Where:
•
Settlement is the settlement date. This is the date on which the security is traded.
•
Maturity is the maturity date. This is the date on which the treasury bill expires.
•
Discount is the discount rate.
Expression
Tbilleq
=
360
Where:
•
DSM is the number of days between settlement and maturity on 360-day basis.
Usage notes
The Settlement date and the Maturity date should be included within single quotations in the expression for the expression to be considered as a valid expression.
316
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Tbillprice (T-bill price)
Returns the price of a treasury bill per $100 of face value.
Syntax
Tbillprice(Settlement, Maturity, Discount)
Where:
•
Settlement is the settlement date. This is the date on which the treasury bill is purchased.
•
Maturity is the maturity date. This is the date on which the treasury bill expires.
•
Discount is the discount rate.
Expression
TBILLPRICE
=
100
– -------------------------------------------------
360
Where:
•
DSM is the number of days from settlement to maturity.
This excludes any maturity date that is more than one calendar year past
Settlement.
Usage notes
•
If Settlement or Maturity is not an integer, it is truncated.
•
The engine returns an empty cell if:
Either Settlement or Maturity is not a valid date.
Discount
0.
Settlement > Maturity.
Maturity is more than one year after Settlement.
•
The Settlement date and the Maturity date should be included within single quotations in the expression for the expression to be considered as a valid expression.
© 2012 MicroStrategy, Inc.
Financial functions
317
4
Plug-In Package Functions MicroStrategy Functions Reference
Tbillyield (T-bill yield)
Returns the yield of a treasury bill.
Syntax
Tbillyield < > (Settlement, Maturity, Price)
Where:
•
Settlement is the settlement date. This is the date on which the treasury bill is purchased.
•
Maturity is the maturity date. This is the date on which the treasury bill expires.
•
Price is the price per $100 of face value
Expression
TBILLYIELD
= par
DSM
Where:
•
DSM is the number of days from settlement to maturity.
This excludes any maturity date that is more than one calendar year past
Settlement.
Usage notes
•
If Settlement or Maturity is not an integer, it is truncated.
•
The engine returns an empty cell if:
Either Settlement or Maturity is not a valid date.
Price
0.
Settlement > Maturity.
Maturity is more than one year after Settlement.
•
The Settlement date and the Maturity date should be included within single quotations in the expression for the expression to be considered as a valid expression.
318
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Vdb (variable declining balance)
Returns the depreciation of an asset over a specified period, including partial periods.
Syntax
Vdb <Factor> (Cost, Salvage, Life, Period)
Where:
•
Factor is the rate at which balance declines.
•
Cost is the initial cost of the asset.
•
Salvage is the value at the end of the depreciation period.
•
Life is the number of periods over which depreciation is calculated.
•
Period is the first period for which depreciation is calculated. This must use the same number of units as Life.
Usage notes
All values must be positive.
Yield
Returns the yield on a security that pays periodic interest.
Syntax
Yield <Basis> (Settlement, Maturity, CouponRate, Price,
Redemption, Frequency)
Where:
•
Settlement is the settlement date. This is the date on which the security is purchased.
•
Maturity is the maturity date. This is the date on which the security expires.
•
CouponRate is the annual interest rate.
•
Price is the price per $100 of face value.
© 2012 MicroStrategy, Inc.
Financial functions
319
4
Plug-In Package Functions MicroStrategy Functions Reference
•
Redemption is the redemption value per $100 of face value.
•
Frequency is the number of payments per year. The valid values are 1, 2, and 4 where annual payments =1, semiannual payments =2, and quarterly payments =4.
•
Basis is a parameter that indicates the time-count basis to be used. The default value for Basis is 0, which is typically used by American agencies and assumes 30-day months and 360-day years (30/360). Other possible values for this parameter are as follows.
Basis value Application
0 (30/360) Assumes 30 days in each month, 360 days in each year.
1 (actual/actual) Assumes actual number of days in each month, actual number of days in each year.
2 (actual/360)
3 (actual/365)
4 (30/60)
Assumes actual number of days in each month, 360 days in each year.
Assumes actual number of days in each month, 365 days in each year.
Used by European agencies, assumes the same values as “0” for American institutions.
Expression
•
If there is one period (or less) until Redemption, this function is calculated as follows.
YIELD =
+ -------------------
100
+
E
–
-----------
100
+
frequency
E
frequency
----------------------------------------------
DSR
Where:
A is the number of days from the beginning of the period to Settlement
DSR is the number of days from Settlement to Redemption
E is the number of days in a period
•
If there is more than one period until Redemption, this function is calculated through iteration, and is based on the calculation for the
PRICE function. See also
Appendix 4, Price (price per $100 face value)
Usage notes
•
If Settlement, Maturity, or Frequency is not an integer, it is truncated.
320
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
•
The engine returns an empty cell if:
Either Settlement or Maturity is not a valid date.
Price
0
or
Redemption
0.
Frequency is a number other than 1, 2, or 4.
Settlement > Maturity.
•
The Settlement date and the Maturity date should be included within single quotations in the expression for the expression to be considered as a valid expression.
Yielddisc (yield on a discounted security)
Returns the annual yield on a discounted security.
Syntax
Yielddisc <Basis> (Settlement, Maturity, Price,
Redemption)
Where:
•
Settlement is the settlement date. This is the date, after issue, on which the security is traded.
•
Maturity is the maturity date. This is the date on which the security expires.
•
Price is the price per $100 of face value.
•
Redemption is the redemption value per $100 of face value.
•
Basis is a parameter that indicates the time-count basis to be used. The default value for Basis is 0, which is typically used by American agencies and assumes 30-day months and 360-day years (30/360). Possible values for this parameter are listed in the following table.
Basis value Application
0 (30/360) Assumes 30 days in each month, 360 days in each year.
1 (actual/actual) Assumes actual number of days in each month, actual number of days in each year.
2 (actual/360) Assumes actual number of days in each month, 360 days in each year.
© 2012 MicroStrategy, Inc.
Financial functions
321
4
Plug-In Package Functions MicroStrategy Functions Reference
Basis value
3 (actual/365)
4 (30/60)
Application
Assumes actual number of days in each month, 365 days in each year.
Used by European agencies, assumes the same values as “0” for American institutions.
Usage notes
•
If Settlement or Maturity is not an integer, it is truncated.
•
The engine returns an empty cell if:
Either Settlement or Maturity is not a valid date.
Price
0
or
Redemption
0.
Maturity
Settlement.
•
The Settlement date and the Maturity date should be included within single quotations in the expression for the expression to be considered as a valid expression.
Yieldmat (yield at maturity)
Returns the annual yield on a security that pays interest at maturity.
Syntax
Yieldmat < Basis> (Settlement, Maturity, Issue, Rate,
Price)
Where:
•
Settlement is the settlement date. This is the date, after issue, on which the security is traded.
•
Maturity is the date of maturity. This is the date on which the security expires.
•
Issue is the issue date.
•
Rate is the annual coupon rate.
•
Price is the price per $100 of face value.
322
Financial functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
•
Basis is a parameter that indicates the time-count basis to be used. The default value for Basis is 0, which is typically used by American agencies and assumes 30-day months and 360-day years (30/360). Possible values for this parameter are listed in the following table.
Basis value Application
0 (30/360) Assumes 30 days in each month, 360 days in each year.
1 (actual/actual) Assumes actual number of days in each month, actual number of days in each year.
2 (actual/360)
3 (actual/365)
4 (30/60)
Assumes actual number of days in each month, 360 days in each year.
Assumes actual number of days in each month, 365 days in each year.
Used by European agencies, assumes the same values as “0” for American institutions.
Usage notes
•
If Settlement, Maturity, or Issue is not an integer, it is truncated.
•
The engine returns an empty cell if:
Rate < 0
Price
0
Settlement
Maturity
•
The Settlement date and the Maturity date should be included within single quotations in the expression for the expression to be considered as a valid expression.
Mathematical functions
The category of Mathematical functions contains more complex math functions than the simple operators found in the Basic functions chapter.
This category includes exponential, logarithmic, and trigonometric functions. These functions are calculated by either the MicroStrategy
Analytical Engine or the database. Those not supported by the database are automatically computed by the Analytical Engine.
© 2012 MicroStrategy, Inc.
Mathematical functions
323
4
Plug-In Package Functions MicroStrategy Functions Reference
Abs (absolute value)
Returns the absolute value of a given number.
The absolute value of a number is the number without a sign. This is a single-value function.
Syntax
Abs(Argument)
Where:
Argument is a metric representing a list of real numbers.
Example
This simple example show the results of executing the Abs function on a list of values. Assuming you have a metric that represents deposit and withdrawal amounts, the function operates as follows:
Abs(Deposit_Withdrawal) where Deposit_Withdrawal is the following list of values: +756.25, -315, +145, -980.35, -75, +1250.78, +560.
The resulting value list is 756.25, 315, 145, 980.35, 75, 1250.78, 560. For
another example of using the Abs function, see
Example 1: Transformed fact , page 7
.
Acos (arc cosine)
Returns the arc cosine of a given number as an angle. This angle is calculated in radians and falls between 0 and . To convert radians to degrees, multiply by 180/. This is a single-value function.
Syntax
Acos(Argument)
Where:
Argument is a metric representing a list of real numbers. The values are the values of the cosine for the angles sought. This value must be between -1 and
1.
324
Mathematical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Acosh (arc cosine, hyperbolic)
Acosh returns the inverse hyperbolic cosine of a number. This function is the inverse of Cosh. Acosh is a single-value function.
For more information on the hyperbolic cosine function, see
Cosh (cosine, hyperbolic), page 329
.
Syntax
Acosh(Argument)
Where:
Argument is a metric representing a list of real numbers with values greater than or equal to 1.
Asin (arc sine)
Returns the arc sine of a given number as an angle. This angle is calculated in radians and falls between -/2 and 2. To convert radians to degrees, multiply by 180/. This is a single-value function.
Syntax
Asin(Argument)
Where:
Argument is a metric representing a list of real numbers. The values are the values of the sine of the angles sought. These values must be between -1 and
1.
Asinh (arc sine, hyperbolic)
Returns the inverse hyperbolic sine of a number. Asinh is the inverse of the
Sinh function. This is a single-value function.
For more information on the hyperbolic sine function, see
Sinh (sine, hyperbolic), page 342
.
© 2012 MicroStrategy, Inc.
Mathematical functions
325
4
Plug-In Package Functions MicroStrategy Functions Reference
Syntax
Asinh(Argument)
Where:
Argument is a metric representing a list of real numbers.
Atan (arc tangent)
Returns the arc tangent of a given number as an angle. This angle is specified in radians and falls between /2 and-2. To convert from radians to degrees, multiply by 180/
Syntax
Atan(Number)
Where:
Number is the tangent of the angle you want.
Atan2 (arc tangent 2)
Returns the arc tangent of the specified x- and y-coordinates. The arc tangent is the angle from the x-axis to a line containing the origin (0, 0) and a point with coordinates (x_num, y_num). The angle is given in radians between - and . To convert the result from radians to degrees, multiply by 180/. This is a single-value function.
Syntax
Atan2(x_num, y_num)
Where:
•
x_num is the x-coordinate of the point.
•
y_num is the y-coordinate of the point.
326
Mathematical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Atanh (arc tangent, hyperbolic)
Returns the inverse hyperbolic tangent of a given number. Atanh is the inverse of the Tanh function. This is a single-value function.
For more information on the hyperbolic tangent function, see
(tangent, hyperbolic), page 344
Syntax
Atanh(Number)
Where:
Number is any real number between 1 and -1.
Ceiling (ceiling value)
Returns the closest integer greater than or equal to a given number.
Ceiling is often used as a rounding function. This is a single-value function.
Syntax
Ceiling(Argument)
Where:
Argument is a metric representing a list of real numbers.
Example
Use ceiling calculations in situations where results are expressed as specified units of measurement. For example, to avoid returns at the cent level,
Ceiling could be used on a product price to round up the figures to the nearest dollar.
© 2012 MicroStrategy, Inc.
Mathematical functions
327
4
Plug-In Package Functions MicroStrategy Functions Reference
This simple example illustrates how the Ceiling function acts on positive and negative numbers, and how the results compare to the use of the Floor function.
Argument values
947.67
463.33
-947.67
-463.33
Floor
947.00
463.00
-948.00
-464.00
Ceiling
948.00
464.00
-947.00
-463.00
Combine (combination)
The number of possible combinations for a given number of items selected as a group from a set.
Syntax
Combine(Number, Number_Chosen)
Where:
•
Number is the number of items in a set.
•
Number_Chosen is the number of items to be included in each combination.
Expression
In the expression that follows, Number = n; Number_Chosen = k,
k
=
P k!
=
!
Where:
P =
!
Usage notes
•
In combination calculations, the internal order of the items selected does not affect the return. This differs from the case of a permutation, in which the order of the items selected does affect the return. Permutation is a statistical function.
328
Mathematical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
•
If an argument is not an integer, it is truncated.
•
This function returns an error value if:
Either argument is nonnumeric
n< 0
k < 0
n
k
Plug-In Package Functions 4
Cos (cosine)
This function takes the value of an angle in radians and returns the cosine of the angle as a number between -1 and 1.
In a given right triangle containing an angle A, there are three sides: the side opposite to A, the side adjacent to A, and the side opposite to the right angle
(hypotenuse). The cosine of A is the ratio of the lengths of the adjacent side over the hypotenuse.
To convert degrees to radians, multiply by /180. This is a single-value function.
Syntax
Cos(Argument)
Where:
Argument is a metric representing a list of real numbers. The values are the angles, in radians, for which the value of the cosine is sought. To convert the result from radians to degrees, multiply by 180/.
Cosh (cosine, hyperbolic)
Returns the hyperbolic cosine of a number. This is a single-value function.
Syntax
Cosh(Argument)
© 2012 MicroStrategy, Inc.
Mathematical functions
329
4
Plug-In Package Functions MicroStrategy Functions Reference
Where:
Argument is a metric representing a list of real numbers. The values are the angles, in radians, for which the value of the hyperbolic cosine is sought. To convert radians to degrees, multiply by 180/.
Expression
= e
2
+
2
– 2
Degrees (conversion to)
Returns the value of an angle converted from radians to degrees. This is a single-value function.
Syntax
Degrees(Argument)
Where:
Argument is a metric representing a list of values to be converted from radians to degrees.
Example
These simple examples illustrate how the Degrees function converts an angle entered in radians into degrees.
Function/Result
Degrees(2.27) = 130
Calculation
1
Degrees(
) = 90
1
=
130
=
90
330
Mathematical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Exp (exponent)
Returns the value e raised to the power of the number given.
e is a mathematical constant equal to 2.71828182845904. Exp is the inverse of Ln, the natural logarithm of a number.
This is a single-value function.
For more information on the natural logarithm function, see
Ln (logarithm, natural), page 334
Syntax
Exp(Argument)
Where:
Argument is a metric representing a list of real numbers. The values are the power to which e is raised
Example
This simple example illustrates the results of using the Exp function. The variable e=2.71828182845904
Function/Result Calculation
Exp (2) = 7.38905609893062
X = e
2
;
2.71828182845904
×
2.71828182845904 = 7.38905609893062
Factorial (factorial)
Returns the factorial of a positive integer. The factorial of an integer N is equal to the product of all integers from 1 to N. For example, the factorial of 5 is 1 × 2 × 3 × 4 × 5, or 120.
This is a single-value function.
Syntax
Factorial(Argument)
© 2012 MicroStrategy, Inc.
Mathematical functions
331
4
Plug-In Package Functions MicroStrategy Functions Reference
Where:
Argument is a metric representing a list of positive integers.
Usage notes
If a number is not an integer or is negative, the function returns a NULL.
Example
These simple examples illustrate the results of using the Factorial function.
Function/Result Calculation
Factorial(5) = 120
Factorial(Argument) = 6, 5040, 362880 where Argument contains the values
3,7,9
5
×
4
×
3
×
2
×
1=120
1
×
2
×
3 = 6;
1
×
2
×
3
×
4
×
5
×
6
×
7 = 5040;
1
×
2
×
3
×
4
×
5
×
6
×
7
×
8
×
9 = 362880
Floor (floor value)
Returns the closest integer less than or equal to a given number. Floor is often used as a rounding function. This is a single-value function.
Syntax
Floor(Argument)
Where:
Argument is a metric representing a list of real numbers.
Example
These simple examples illustrate how the Floor function acts on positive and negative numbers, and how the results compare to the use of the
Ceiling function.
Argument Values
947.67
463.33
Floor
947.00
463.00
Ceiling
948.00
464.00
332
Mathematical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Argument Values
-947.67
-463.33
Floor
-948.00
-464.00
Plug-In Package Functions 4
Ceiling
-947.00
-463.00
Int (integer)
Returns the integer part of a number rounded down to the nearest integer.
This is a single-value function.
Syntax
Int(Argument)
Where:
Argument is a metric representing a list of real numbers.
Usage notes
•
The expression [Argument - INT(Argument)] can be used to return the decimal part of a non-integer.
•
Results from Int and Trunc differ only when the values are less than 0.
Example
These simple examples illustrate how the Int function acts on positive and negative numbers, and how the results differ from the Trunc function when the numbers are negative.
Argument Values
947.67
463.33
-947.67
-463.33
Int
947.00
463.00
-948.00
-464.00
Trunc
947.00
463.00
-947.00
-463.00
© 2012 MicroStrategy, Inc.
Mathematical functions
333
4
Plug-In Package Functions MicroStrategy Functions Reference
Ln (logarithm, natural)
Returns the natural logarithm of a given number.
This is a single-value function. Ln is the inverse of the Exp function.
For more information on the Exponent function, see
Syntax
Ln(Argument)
Where:
Argument is a metric representing a list of positive real numbers.
Example
This simple example illustrates the results of the Ln function. The variable e=
2.71828182845904.
Function/Result
Ln (20) =
2.99573227355399
Calculation
20 = e
20= e x where x is the natural logarithm;
2.99573227355399
Log (logarithm)
Returns the logarithm of a given number in a specified base. This is a single-value function.
Syntax
Log(Argument, Base)
Where:
•
Argument is a metric representing a list of positive real numbers.
•
Base is the base of the logarithm.
334
Mathematical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Example
This simple example illustrates the results of the Log function.
Function/Result
Log(9, 3) = 2
Log(4, 4) = 1
Log (7776, 6) = 5
Calculation
9 = 3 x where x is the base-3 logarithm; 9 = 3
2
4 = 4 x where x is the base-4 logarithm; 4 = 4
1
7776 = 6 x where x is the base-6 logarithm; 7776 = 6
5
Log10 (logarithm, base 10)
Returns the base-10 logarithm of a given number. This is a single-value function.
Syntax
Log10(Argument)
Where:
Argument is a metric representing a list of positive real numbers.
Example
This simple example illustrates the results of the Log10 function.
Function/Result
Log10(10000) = 4
Calculation
10000 = 10 x where x is the base-10 logarithm; 10000 = 10
4
Mod (modulus)
Returns the remainder of a number when divided by a another number. The result has the same sign as the divisor. This is a single-value function.
Syntax
Mod (Argument, Divisor)
© 2012 MicroStrategy, Inc.
Mathematical functions
335
4
Plug-In Package Functions MicroStrategy Functions Reference
Where:
•
Argument is a metric representing a list of real numbers.
•
Divisor is the number used to divide the value(s) of Argument.
Usage notes
•
The function returns a NULL if Divisor = 0.
•
Use the Quotient function to return only the integral part of the result.
Example
These simple examples illustrate the results of using the Mod function.
Function/Result Calculation
Mod(5, 2) = 1
Mod(5, -2) = -1
Mod(-5, 2) = 1
Mod(140, 2) = 0
Mod(83, 9) = 2
Mod(-5, -2) = -1
5/2 = 2 remainder 1
5/-2 = 2 remainder 1 and takes the sign of the divisor
-5/2 = 2 remainder 1 and takes the sign of the divisor
140/2 = 70 remainder 0
83/9 = 9 remainder 2
-5/-2 = 2 remainder 1 and takes the sign of the divisor
Power
Returns the value of an input number raised to a given power. This is a single-value function.
Syntax
Power(Argument, Power)
Where:
•
Argument is a metric representing a list of base numbers. All real numbers are valid.
•
Power is the exponent to which Argument is raised.
336
Mathematical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Usage notes
If Argument is a negative number and Power is an even number, the result is positive; however, if Argument is negative and Power is an odd number, the result is negative.
Example
These simple examples illustrate the results of using the Power function.
Function/Result Calculation
Power(5, 2) = 25 5
×
5 = 25
Power(-5, 2) = 25
Power(-5, 3) = -125
Power(4, 3) = 64
-5
×
-5 = 25
-5
×
-5
×
-5 = -125
4
×
4
×
4 = 64
Power(20,4) = 160000 20
×
20
×
20
×
20 = 160000
Quotient
Returns the integer result of dividing two numbers. This function discards the remainder. This is a single-value function.
Syntax
Quotient(numerator, denominator)
Where:
•
Numerator is a metric representing a list of real numbers to be used as the dividend.
•
Denominator is a metric representing a list of real numbers to be used as the divisor.
Usage notes
remainder.
© 2012 MicroStrategy, Inc.
Mathematical functions
337
4
Plug-In Package Functions MicroStrategy Functions Reference
Example
These simple examples illustrate the results of using the Quotient function.
Function/Result
Quotient(5, 2) = 2
Quotient(83, 9) = 9
Calculation
5/2 = 2 remainder 1
83/9 = 9 remainder 2
Radians (conversion to)
Returns the value of an angle converted from degrees to radians. This is a single-value function.
Syntax
Radians(Argument)
Where:
Argument is a metric representing a list of values to convert from degrees to radians.
Example
This simple example illustrates how the Radians function converts an angle entered in degrees into radians.
Function/Result
Radians(130) = 2.27
Calculation
1
180
=
2.27
Randbetween (random number between two values)
Returns a random number that falls between two specified values. The value returned is a real number, as opposed to an integer value.
A different number is returned each time the function is run. However, if the
Randbetween function is used to modify multiple rows of values on a report,
338
Mathematical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4 be aware that if you use a simple definition such as Randbetween(2, 10) the same random number will be applied to each row of data on the report. You can apply a different random number to each row of data in a report by including metric values in the Randbetween calculation, and an example of this is provided below.
Syntax
Randbetween(Bottom, Top)
Where:
•
Bottom is a real number or metric representing a list of real numbers that are the lowest value(s) the function can return; the bottom of the range. You can also include expressions that result in a real number value.
•
Top is a real number or metric representing a list of real numbers which are the highest value(s) the function can return; the top of the range. You can also include expressions that result in a real number value.
Example
Random numbers are used often in statistical analysis. A common practice is to apply a random percentage to another value. To do this, you can use the
Randbetween function to return a number between 0 and 1. This can be achieved with the following syntax:
Randbetween(0, 1)
This returns a real number value between zero and one. This can be used in an expression to multiply against another value, which would return a random percentage of that value. For example, you can return a random percentage of revenue by creating a metric with the following definition:
(Sum(Revenue) {~+} * Randbetween(0, 1))
When using a metric with this definition on a report the same random percentage is applied to all revenue values on a report.
In the definition provided below, the metric Revenue is used in the
Randbetween calculation. By including the revenue data as part of the calculation of Randbetween, a different random number is generated for each row of revenue data on a report.
Randbetween(0, Revenue)
© 2012 MicroStrategy, Inc.
Mathematical functions
339
4
Plug-In Package Functions MicroStrategy Functions Reference
These two metrics are created as Random Revenue 1 and Random Revenue 2 respectively, and displayed on the same report shown below:
Notice that the metric Random Revenue 2, which includes the revenue data as part of the Randbetween calculation, is using a different percentage for each row of revenue data. However, the metric Random Revenue 1 which uses a simple definition of the Randbetween calculation as
Randbetween(0,1) uses the same random percentage to modify all rows of Revenue data.
Round (round to nearest integer)
Returns the input values rounded to the nearest integer. This is a single-value function.
Syntax
Round(Argument)
Where:
Argument is a metric representing a list of real numbers.
Example
These simple examples illustrate the result of using the Round function, and compare them to the Int function results for the same values.
Argument Values
947.67
463.33
-947.67
-463.33
Round
948.00
463.00
-948.00
-463.00
Int
947.00
463.00
-948.00
-464.00
340
Mathematical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Round2 (round to specified precision)
Returns the input values rounded to a specified number of digits. This is a single-value function.
Syntax
Round2(Argument, Precision)
Where:
•
Argument is a metric representing a list of real numbers
•
Precision is an integer value specifying the placement of the digits to which the Argument value(s) are rounded.
If Precision = 0, then the values are rounded to the nearest integer.
This has the same results as using the Round function.
If Precision is greater than 0, then the values are rounded to the decimal place indicated.
If Precision is less than 0, then the values are rounded to the specified digits to the left of the decimal and starting to the left of the integer in the ones place.
Example
This simple example illustrates how the Precision value affects the results of the Round2 function.
Argument values
947.67
811.00
463.33
Round2(argument, 0) Round2(argument, 1) Round2(argument, -1)
948.00
811.00
463.00
947.70
811.00
463.30
950.00
810.00
460.00
Sin (sine)
This function takes the value of an angle in radians and returns the sine of the angle as a number between -1 and 1.
In a given right triangle containing an angle A, there are three sides: the side opposite to A, the side adjacent to A, and the side opposite to the right angle
© 2012 MicroStrategy, Inc.
Mathematical functions
341
4
Plug-In Package Functions MicroStrategy Functions Reference
(hypotenuse). The sine of A is the ratio of the lengths of the opposite side over the hypotenuse.
To convert degrees to radians, multiply by /180. This is a single-value function.
Syntax
Sin(Argument)
Where:
Argument is a metric representing a list of values. The values are angles, in radians, for which the sine is sought.
Multiplying the argument by /180 converts an angle from degrees to radians.
Sinh (sine, hyperbolic)
Returns the hyperbolic sine of a given angle. The value of the hyperbolic sine is used to approximate a cumulative probability distribution. This is a single-value function.
Syntax
Sinh(Argument)
Where:
Argument is a metric representing a list of values. The values are angles, in radians, for which the hyperbolic sine is sought. Multiplying the argument by
/180 converts an angle from degrees to radians.
Expression
=
2
–
2 e
–
2
Sqrt (square root)
Returns the square root of a given positive number. This is a single-value function.
342
Mathematical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Syntax
Sqrt(Argument)
Where:
Argument is a metric representing a list of positive real numbers.
Usage notes
A NULL is returned if an argument value is less than 0.
Example
This simple example illustrates the results of using the Sqrt function.
Sqrt(25) = 5
Sqrt(169) = 13
Tan (tangent)
This function takes the value of an angle in radians and returns the tangent of the angle.
In a given right triangle containing an angle A, there are three sides: the side opposite to A, the side adjacent to A, and the side opposite to the right angle
(hypotenuse). The tangent of A is the ratio of the lengths of the opposite side over the adjacent side.
To convert degrees to radians, multiply by /180. This is a single-value function.
Syntax
Tan(Argument)
Where:
Argument is a metric representing a list of real numbers.
© 2012 MicroStrategy, Inc.
Mathematical functions
343
4
Plug-In Package Functions MicroStrategy Functions Reference
Tanh (tangent, hyperbolic)
Returns the value of the hyperbolic tangent of a given number. This is a single-value function.
Syntax
Tanh(Argument)
Where:
Argument is a metric representing a list of real numbers.
Expression
=
COSH z
Trunc (truncate)
Returns the integer component of a given number. The function removes the fractional part of a real number so that only the integer part remains. The fractional part is removed without rounding the number up or down. This is a single-value function.
Syntax
Trunc(Argument)
Where:
Argument is a metric representing a list of real numbers.
Usage notes
Results from Trunc and Int differ only when the values are less than 0.
344
Mathematical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Example
This simple example illustrates how the Trunc function acts on positive and negative numbers, and how it differs from the Int function.
Argument Values
947.67
463.33
-947.67
-463.33
Int
947.00
463.00
-948.00
-464.00
Trunc
947.00
463.00
-947.00
-463.00
Statistical functions
The statistical functions include a wide range of functions designed to provide you with the tools to perform statistical analysis on your data.
AvgDev (average deviation)
Returns the average of the absolute deviations of a set of data points from the mean.
Similar to standard deviation, average deviation is a measure of the variability in a data set.
Syntax
AvgDev <FactID> (Argument)
Where:
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
•
Argument is a fact or metric representing a list of numbers.
Expression
In this expression, x is a value in a fact table.
© 2012 MicroStrategy, Inc.
Statistical functions
345
4
Plug-In Package Functions n n
i = 1 x i
– x
•
Where: x
is the average of all x
i
MicroStrategy Functions Reference
BetaDistribution
Returns the cumulative Beta distribution of the variables alpha and beta, where the probability density function is given by
=
x a
b x
Where:
B
=
0
1 t
d t
This function is used to study percentage variations for an item across population samples (for example, how much of a day people spend watching television).
Syntax
BetaDistribution < Lower Bound, Upper Bound > (x, alpha,
beta)
Where:
•
x is the value between Lower Bound (a) and Upper Bound (b) at which the function is evaluated.
•
alpha and beta are distribution parameters.
alpha =
beta =
•
Lower Bound is an optional lower bound of the interval of x.
346
Statistical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
•
Upper Bound is an optional upper bound of the interval of x.
Usage notes
The following are invalid conditions:
•
x, alpha, or beta is nonnumeric.
•
alpha 0 or beta 0.
•
x < Lower Bound or x > Upper Bound.
•
Lower Bound = Upper Bound.
BinomialDistribution
Returns either the binomial probability or the cumulative binomial probability of variables n and p.
This function is used in cases in which:
•
There is a fixed number of tests
•
Each test can only result in either success or failure (binary)
•
Tests are independent of all other tests
•
The probability of success is constant, for example, to calculate the probability that two out of the next three babies will be male
Syntax
BinomialDistribution <Cumulative> (x, n, p)
Where:
•
x is the number of successes.
•
n is the number of tests.
•
p is the number indicating the probability of a success in each trial.
•
Cumulative is a logical value that determines the form of the function.
If Cumulative=0, it computes the Cumulative Binomial probability.
If Cumulative=1, it computes the Binomial probability.
© 2012 MicroStrategy, Inc.
Statistical functions
347
4
Plug-In Package Functions
Expression
For the binomial probability:
= x
Where:
•
x is Combine(n, x).
The cumulative binomial distribution is: x
=
y = 0
Usage notes
•
If x or n is not an integer, it is truncated.
•
The following are invalid conditions:
One of the arguments is nonnumeric.
x > n.
x< 0.
p < 0 or p > 1.
MicroStrategy Functions Reference
ChiSquareDistribution
Returns the cumulated chi-squared distribution of the degrees of freedom, where the probability density function is given by
= x
2
exp
------------------------
2
2
n
2 x
2
•
•
Where: n
is the degree of freedom
is the gamma function
348
Statistical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
The chi-squared distribution is associated with a chi-squared test. A chi-squared test is used to compare observed values against expected ones. It determines the validity of a hypothesis, such as the prediction that the next generation of a certain plant hybrid will exhibit a specific combination of colors.
Syntax
ChiSquareDistribution(x, df)
Where:
•
x is a non-negative decimal value at which the distribution is evaluated.
•
df is an integer greater than or equal to one (>=1) indicating the number of degrees of freedom for the distribution.
Usage notes
•
If df is not an integer, it is truncated
•
The following are invalid conditions:
Either argument is nonnumeric
x < 0
df < 1
ChiSquareTest (chi-square test for goodness of fit)
Returns the result of a test for goodness of fit.
This function returns the chi-squared distribution for a statistical value and its associated degrees of freedom to determine, for example, to what extent an experiment verifies hypothesized results.
Decision
Accept H
0
Reject H
0
Reality:
H
0
is correct
No problem
Type 2 error
Reality:
H
1
is correct
Type 1 error
No problem
© 2012 MicroStrategy, Inc.
Statistical functions
349
4
Plug-In Package Functions MicroStrategy Functions Reference
Definition
P-value = Pr[Reject H
0
| H
0 is correct]
P-value is a probability of making a Type 2 error.
ChiSquareTest returns the p-value for the hypothesis test in the following form:
•
H
0
: Argument1 and argument2 come from the same distribution.
•
H
1
: Argument1 and argument2 come from different distributions.
Syntax
ChiSquareTest(Argument1, Argument2)
Where:
•
Argument1 is a fact or metric representing a list of values that contains observed values, which are to be tested against expected values.
•
Argument2 is a fact or metric representing a list of expected values, which are compared against the observed values provided by
Argument1.
Usage notes
•
This function returns the probability for a chi-squared (x
2 its associated degrees of freedom (df).
) statistic and
•
This function results in an invalid value if Argument1 and Argument2 have a different number of data points. Meaning, each observed value must have an expected value to be compared to.
Confidence (confidence interval)
Returns the confidence interval for a population mean.
The confidence interval is a range of values on either side of a mean. For example, if you order a product through the mail, you can determine, within a given level of confidence, the earliest and latest date of expected arrival.
Syntax
Confidence(Alpha, Stdev, Size)
350
Statistical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Where:
•
Alpha is the level of significance at which confidence is computed.
•
Stdev is the standard deviation of the population for the given data range.
•
Size is a positive integer indicating the size of the sample.
Expression
The confidence level is expressed as [100(1-alpha)%]. If alpha = 0.05, then:
•
Confidence = 95%
•
The area equivalent to 95% of the population = 1.96
•
The confidence interval is
n
Usage notes
•
If size is not an integer, it is truncated.
•
The following are invalid conditions:
One of the arguments is nonnumeric.
alpha < 0 or alpha >1
stdev < 0
size < 1
Example
For an example of the Confidence function in use, see
Confidence level example, page 75
Correlation
Returns the correlation coefficient between two data sets. Correlation indicates association between two quantitative variables and the degree to which the values are related or associated.
This function is the same as the
Pearson (Pearson product moment correlation coefficient), page 381
Statistical functions
351
© 2012 MicroStrategy, Inc.
4
Plug-In Package Functions MicroStrategy Functions Reference
Syntax
Correlation <FactID> (Argument1, Argument2)
Where:
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
•
Argument1 and Argument2 are lists of values represented by facts or metrics.
Usage notes
•
The correlation coefficient is measured on a scale that varies from + 1 through 0 to - 1. So only a value between -1 and 1 is returned.
•
Complete correlation between two variables is expressed by either + 1 or
-1. When one variable increases as the other increases, the correlation is positive; when one decreases as the other increases, the correlation is negative. Complete absence of correlation is represented by 0.
•
If an array or reference argument contains text, logical values, or empty cells, those values are ignored; however, cells with the value zero are included.
•
If Argument1 and Argument2 have a different number of data points,
Correlation returns an error.
•
If either Argument1 or Argument2 is empty, or if the standard deviation of their values equals zero, Correlation returns an error.
Covariance
Covariance is used to examine the relationship between two data sets. For instance, the covariance could be used to examine whether an increase in income is related to higher education levels. A covariance greater or less than zero indicate a relationship, while a value of zero indicates no relationship.
Syntax
Covariance <FactID> (Argument1, Argument2)
352
Statistical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Where:
•
Argument1 and Argument2 are facts or metrics representing lists of values.
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
Expression
In the expression that follows:
•
Argument1 = X
•
Argument2 = Y
= n
i = 1
x i
–
x i
–
y
•
•
Where:
x
y
= average value of x
= average value of y
Usage notes
The following are invalid conditions:
•
Argument1 and Argument2 do not contain the same number of data points.
•
Either value set is empty.
CritBinomial (criterion binomial)
Returns the smallest value for which the cumulative binomial distribution is greater than or equal to a criterion value. Use this function for quality control, for example, to determine the maximum number of defective items that can come off an assembly line run before rejecting an entire lot.
Syntax
CritBinomial(Trials, Probability_s, Alpha)
© 2012 MicroStrategy, Inc.
Statistical functions
353
4
Plug-In Package Functions MicroStrategy Functions Reference
Where:
•
Trials is the number of Bernoulli trials.
•
Probability_s is the probability of a success on each trial.
•
Alpha is the criterion value.
Usage notes
The following are invalid conditions:
Where:
•
Any argument is nonnumeric.
•
Trials is not an integer.
•
Trials < 0.
•
Probability_s is < 0 or probability_s > 1.
•
alpha < 0 or alpha > 1.
ExponentialDistribution
Returns either the probability density or the cumulative distribution of a random variable. This function is used to model the time between events. For example, it can be used to estimate the probability that an automatic-teller machine will take no more than one minute to deliver requested cash.
Syntax
ExponentialDistribution <Cumulative> (x, lambda)
Where:
•
Cumulative is a logical value that determines the form of the function:
If Cumulative=0 (default), it returns the cumulative distribution.
If Cumulative=1, it returns the probability density.
•
x is the value of the function.
•
lambda is the value of the parameter.
354
Statistical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Expression
•
For probability density: f x
=
e
–
x
•
For cumulative distribution:
F x
=
–
–
x
Usage notes
The following are invalid conditions:
•
Either x or lambda is nonnumeric.
•
x<0.
•
lambda 0.
Plug-In Package Functions 4
Fisher (fisher transformation)
Returns the Fisher transformation at x. The Fisher transformation yields a normally-distributed function, as opposed to a skewed one. It is used to perform hypothesis-testing on the correlation coefficient.
Syntax
Fisher (x)
Where:
x is the number for which the transformation is sought.
Expression
z' =
2
1 x
1 x
Usage notes
The following are invalid conditions:
•
x is nonnumeric.
•
x -1 or x 1.
© 2012 MicroStrategy, Inc.
Statistical functions
355
4
Plug-In Package Functions MicroStrategy Functions Reference
FDistribution (f-probability distribution)
Returns the cumulative distribution (F-probability) of a random variable.
This function is used to determine the difference, in degrees of diversity, between two data sets. For example, test scores administered to males and females entering high school can be examined using this function to determine whether the variability in females is different from that found in males.
Syntax
FDistribution(x, df
1
, df
2
)
Where:
•
x is the value at which the function is evaluated.
•
df
1
represents the degrees of freedom of numerator values.
•
df
2
represents the degrees of freedom of denominator values.
Expression
P =
F X
Where:
F is a random variable that has a F distribution.
Usage notes
•
If df
1
or df
2
is not an integer, it is truncated.
•
The following are invalid conditions:
An argument is non-numeric.
x<0.
df
1
< 1
df
2
< 1
Forecast
The Forecast function uses data recorded for certain time periods to calculate and display the expected value of data for an unknown time period.
356
Statistical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
This is most commonly used to predict future metric values based on historical data. For example, based on revenue data for three years, you want to predict what your Revenue will be for the coming year.
This function uses a linear equation to predict future values. Therefore, it is best suited to predict values that increase or decrease in a linear trend. For example, if your profits are increasing by $10,000 each year, this is a scenario that is well suited for a prediction based on a linear equation.
For a function that predicts values in a similar way for data that is increasing
or decreasing exponentially, see
Syntax
Forecast <FactID>(FutureTime, KnownData1,...,KnownDataN,
KnownTimeIntervals1,...,KnownTimeIntervalN)
Where:
•
FutureTime is the point in time for which to predict the data. This is commonly defined as an integer. For example, to predict values for the year 2009, you would enter the value 2009 for FutureTime (this assumes your year data is defined with IDs that match the year).
•
KnownData1,...,KnownDataN are separate scalar values that provide the data to use to predict a future value for. While you can use Forecast to enter these values manually, it is more common to use ForecastV which can use a metric to enter a list of values, as described in
(forecast, vector input), page 358
.
•
KnownTimeIntervals1,...,KnownTimeIntervalN are separate scalar values that provide the time intervals for which data is known.
While you can use Forecast to enter these values manually, it is more common to use ForecastV which can use an attribute to enter a list of time intervals, as described in
ForecastV (forecast, vector input), page 358
.
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
Example
As described in the syntax requirements, you can use Forecast to enter values and time intervals manually. However, it is more common to use
ForecastV to use metrics and attributes to enter this information, as described in
ForecastV (forecast, vector input), page 358
.
© 2012 MicroStrategy, Inc.
Statistical functions
357
4
Plug-In Package Functions MicroStrategy Functions Reference
ForecastV (forecast, vector input)
The ForecastV function uses data recorded for certain time periods to calculate and display the expected value of data for an unknown time period.
This is most commonly used to predict future metric values based on historical data. For example, based on revenue data for three years, you can predict what your Revenue will be for the coming year.
You can use ForecastV to predict values for any point in time, including dates that have known data. However, this type of function is meant for predicting future, unknown values.
This function uses a linear equation to predict future values. Therefore, it is best suited to predict values that are increasing or decreasing in a linear trend. For example, if your profits are increasing by $10,000 each year, this is a scenario that is well suited for a prediction based on a linear equation.
For a function that predicts values in a similar way for data that is increasing
or decreasing exponentially, see
GrowthV (growth, vector input), page 363
Syntax
ForecastV <FactID>(FutureTime, KnownData,
KnownTimeIntervals)
Where:
•
FutureTime is the point in time for which to predict the data. This is commonly defined as an integer. For example, to predict values for the year 2009, you would enter the value 2009 for FutureTime (this assumes your year data is defined with IDs that match the year).
•
KnownData is an object representing a list of values. This list of values is the known data to use to predict a future value for. KnownData is commonly used for metrics that represent data such as revenue, profit, and so on.
•
KnownTimeIntervals is an object representing a list of values. This list of values provide the time intervals for which data is known.
KnownTimeIntervals is commonly used for attributes that represent intervals of time such as year, quarter, month, and so on.
Since this function allows you to enter a list of time intervals, it can account for missing time intervals more accurately than the TrendV function (see
TrendV (trend, vector input), page 389
). For an example, see the examples described below.
358
Statistical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
Example
The ForecastV function is useful to display predicted future values of a metric as a subtotal of the metric on a report.
For example, in the MicroStrategy Tutorial project a new subtotal named
2008 Forecast can be created with the following definition:
ForecastV(2008, x, Year)
Since this is in a subtotal, the x is a placeholder for a metric. When a subtotal is applied to a metric on a report, the placeholder inputs that metric’s values.
Also, 2008 is used for the period in time to predict metric data for because the Year attribute uses ID values that match the year.
After making the new custom subtotal available for the Revenue metric (see the Advanced Reporting Guide for steps to make custom subtotals available for metrics) a report with the attribute Year and the metric Revenue is created. When the 2008 Forecast is displayed on the report, it displays the predicted value for 2008 Revenue, as shown below:
Since the ForecastV function allows you to enter a list of time intervals, it can account for time intervals that you have no data for. For example, consider the same report in a scenario in which there was no data available for the year 2006. The ForecastV function can still use the two available years to predict the revenue for 2008.
© 2012 MicroStrategy, Inc.
Statistical functions
359
4
Plug-In Package Functions
FTest
MicroStrategy Functions Reference
Returns the P-value of an F-test on the variances of two sets of data. It tests that the variances in the two sets are not significantly different. For example, given the test scores from public and private schools, this function enables you to determine whether diversity levels between the two school types are significantly different.
Decision
Accept H
0
Reject H
0
Reality:
H
0
is correct
No problem
Type 2 error
Reality:
H
1
is correct
Type 1 error
No problem
Definition
P-value = Pr[Reject H
0
| H
0 is correct]
P-value is basically a probability of making a Type 2 error.
FTest returns the p-value for the hypothesis test in the following form:
•
H
0
:
(Argument1) /
2
2
(Argument2) = Ratio
•
H
1
:
2
2
(Argument1) / (Argument2) <
Ratio (Type = -1)
2
2
(Argument1) / (Argument2)
Ratio (Type = 0: two-sided test)
2
2
(Argument1) / (Argument2) >
Ratio (Type = 1)
2
2
(Argument1) / (Argument2)
Ratio (Type = 2: one-sided test)
Syntax
FTest <Hypothesis type, Ratio> (Argument1, Argument2)
360
Statistical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Usage notes
The following are invalid conditions:
•
Argument1 and Argument2 contain a different number of data points.
•
The variance of either data set is zero.
GammaDistribution
Returns either the cumulative Gamma distribution or the probability density of a random variable.
This function is used in queueing analysis to study variables that may have a skewed distribution.
Syntax
GammaDistribution <Cumulative> (x, Alpha, Beta)
Where:
•
x is the value at which you want to evaluate the distribution.
•
Alpha is a distribution parameter.
•
Beta is a distribution parameter.
•
Cumulative is a logical value that determines the form of the function:
If Cumulative=0 (default), it returns the cumulative distribution.
If Cumulative=1, it returns the probability density.
Expression
=
e
–
The expression for the standard gamma distribution is:
= e
– x
If alpha = 1, this function returns the exponential distribution as:
=
© 2012 MicroStrategy, Inc.
Statistical functions
361
4
Plug-In Package Functions MicroStrategy Functions Reference
Usage notes
•
When alpha > 0, this function is also known as the Erlang distribution.
•
The following are invalid conditions:
Either alpha or beta is nonnumeric.
Either alpha 0 or beta 0.
x < 0.
Growth
The Growth function uses data recorded for certain time intervals to calculate and display the expected value of data for an unknown time period.
This is most commonly used to predict future metric values based on historical data. For example, based on revenue data for three years, you can predict what your Revenue will be for the coming year.
This function uses an exponential equation to predict future values.
Therefore, it is best suited to predict values that increase or decrease in an exponential trend. For example, if your profits are increasing by 4 percent each year, this is a scenario that is well suited for a prediction based on an exponential equation.
For a function that predicts values in a similar way for data that is increasing or decreasing with a linear trend, see
or
Syntax
Growth <FactID, SortBy>
(KnownData1,...,KnownDataN, FutureTimeOffset)
Where:
•
KnownData1,...,KnownDataN are separate scalar values that provide the data to use to predict a future value for. While you can use Growth to enter these values manually, it is more common to use GrowthV which can use a metric to enter a list of values, as described in
(growth, vector input), page 363
.
•
FutureTimeOffset is the point in time after the final time interval available for which to predict the data. This is commonly defined as an integer. For example, to predict values for the year 2009 when the last
362
Statistical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4 available data you have is for 2007, you would enter the value of 2 for
FutureTimeOffset.
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
•
SortBy is a parameter that defines the order of calculation. For more information, see
BreakBy and SortBy parameters, page 19
Example
As described in the syntax requirements, you can use Growth to enter values manually. However, it is more common to use GrowthV to use metrics and
attributes to enter this information, as described in
GrowthV (growth, vector input), page 363
.
GrowthV (growth, vector input)
The GrowthV function uses data recorded for certain time intervals to calculate and display the expected value of data for an unknown time period.
This is most commonly used to predict future metric values based on historical data. For example, based on revenue data for three years, you want to predict what your Revenue will be for the coming year.
You can use GrowthV to predict values for any point in time, including dates that have known data. However, this type of function is meant for predicting future, unknown values.
This function uses an exponential equation to predict future values.
Therefore, it is best suited to predict values that increase or decrease in an exponential trend. For example, if your profits are increasing by 15 percent each year, this is a scenario that is well suited for a prediction based on a linear equation.
For a function that predicts values in a similar way for data that is increasing or decreasing with a linear trend, see
ForecastV (forecast, vector input), page 358
TrendV (trend, vector input), page 389
Syntax
GrowthV <FactID, SortBy>(KnownData, FutureTimeOffset)
Statistical functions
363
© 2012 MicroStrategy, Inc.
4
Plug-In Package Functions MicroStrategy Functions Reference
Where:
•
KnownData is an object representing a list of values. This list of values is the known data to use to predict a future value for. KnownData is commonly used for metrics that represent data such as revenue, profit, and so on.
•
FutureTimeOffset is the point in time after the final time interval available for which to predict the data. This is commonly defined as an integer. For example, to predict values for the year 2009 when the last available data you have is for 2007, you would enter the value of 2 for
FutureTimeOffset.
The GrowthV function assumes that data is available for sequential time intervals with no missing data. If your data meets these requirements, this allows you to use a single expression to use on reports with varying time intervals such as year, month, quarter, and so on. For an example, see the examples described below.
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
•
SortBy is a parameter that defines the order of calculation. For more information, see
BreakBy and SortBy parameters, page 19
Example
The GrowthV function is useful to display predicted future values of a metric as a subtotal of the metric on a report.
For example, in the MicroStrategy Tutorial project a new subtotal named
2008 Growth can be created with the following definition:
GrowthV(x, 1)
Since this is in a subtotal, the x is a placeholder for a metric. When a subtotal is applied to a metric on a report, the placeholder inputs that metric’s values.
Also, 1 is used as the offset in the time interval to predict data for the first time interval that is not known.
After making the new custom subtotal available for the Revenue metric (see the Advanced Reporting Guide for steps to make custom subtotals available for metrics) a report with the attribute Year and the metric Revenue is
364
Statistical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4 created. When the 2008 Growth is displayed on the report, it displays the predicted value for 2008 Revenue, as shown below:
This predicted value is different than the values predicted by the functions
ForecastV and TrendV, as described in
ForecastV (forecast, vector input), page 358
and
TrendV (trend, vector input), page 389
to GrowthV predicting values based on an exponential trend, and as such should be used with data that reflects such a trend.
HeteroscedasticTTest and HomoscedasticTTest
Return the P-value for the hypothesis test. These two functions are used to determine the level of variance between the means of paired samples, assuming both samples have different arguments. For example, they may be used when a given group is to be tested before and after an experiment.
Decision
Accept H
0
Reject H
0
Reality:
H
0
is correct
No problem
Type 2 error
Reality:
H
1
is correct
Type 1 error
No problem
Definition
P-value = Pr[Reject H
0
| H
0
is correct]
P-value is a probability of making a Type 2 error.
HeteroscedasticTTest or HomoscedasticTTest returns the p-value for the hypothesis test in the following form:
•
For H
0
:
Statistical functions
365
© 2012 MicroStrategy, Inc.
4
Plug-In Package Functions MicroStrategy Functions Reference
•
For H
1
:
offset (Type = -1)
(Argument1) - (Argument2)
offset (Type = 0: two-sided test)
(Argument1) - (Argument2) > offset (Type = 1)
(Argument1) - (Argument2)
offset (Type = 2: one-sided test)
Syntax
HeteroscedasticTTest or HomoscedasticTTest <Hypothesis type, offset> (Argument1, Argument2)
Usage notes
•
Heteroscedastic t-tests are based on the assumption that variances between two sample data ranges are unequal [
(Argument2)].
2
2
(Argument1)
•
Homoscedastic t-tests are based on the assumption that variances between two sample data ranges are equal [
(Argument2)].
2
2
(Argument1)
•
The following are invalid conditions:
Argument1 and Argument2 have a different number of data points, and Hypothesis type = 1 (paired).
Offset or Hypothesis type is nonnumeric.
Example
For an example using both Heteroscedastic T-test and Homoscedastic T-test, see
Hypothesis Testing example, page 68
HypergeometricDistribution
Returns the probability of a given number of sample successes, given the sample size, population successes, and population size. Use this function for problems with a finite population, where each observation is either a success
366
Statistical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4 or a failure, and where each subset of a given size is chosen with equal likelihood.
Syntax
HypergeometricDistribution(x, n, M, N)
Where:
•
x is the number of successes in the sample.
•
n is the size of the sample.
•
M is the number of successes in the population.
•
N is the population size.
Expression
= x
=
; ,
=
M
---------------
N n
Usage notes
•
All arguments are truncated to integers.
•
The following are invalid conditions:
Any argument is nonnumeric.
x < 0 or x is greater than the lesser of n or M.
x is less than the larger of 0 or (n - N + M).
n < 0 or n > N.
M < 0 or M > N.
N < 0.
Intercept
Returns the point at which a line intersects the y-axis in a graph. This function is used to determine the value of a dependent variable Y when the value of its associated independent variable X is 0. The point of intersection
© 2012 MicroStrategy, Inc.
Statistical functions
367
4
Plug-In Package Functions MicroStrategy Functions Reference is based on a best-fit regression line plotted through available values of X and
Y.
Syntax
Intercept <FactID> (Argument1, Argument2)
Where:
•
Argument1 is the dependent set of observation data represented by a fact or metric.
•
Argument2 is the independent set of observation data represented by a fact or metric.
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
Expression
In the expressions that follow, Argument1 = Y, Argument2 = X.
The equation for the intercept of the regression line is a = Y bX
The slope of the regression line is calculated as: b = n
n xy
------------------------------
x
–
2
–
x
x
2 y
Usage notes
This function results in an invalid value if Argument1 and Argument2 contain a different number of data points.
Example
For an example using the Intercept function, see
.
InverseBetaDistribution (inverse of the beta distribution)
Returns the inverse of the cumulative Beta distribution.
368
Statistical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
For information on the Beta distribution function, see
Syntax
InverseBetaDistribution <Lower Bound, Upper Bound> (x,
Alpha, Beta)
Where:
•
x is a probability associated with the beta distribution.
•
Alpha and Beta are distribution parameters.
•
Lower Bound is an optional lower bound of the interval of x.
•
Upper Bound is an optional upper bound of the interval of x.
Usage notes
The following are invalid conditions:
•
x, alpha, or beta is nonnumeric.
•
alpha 0 or beta 0.
•
x 0 or x
1.
•
x < Lower Bound or x > Upper Bound.
•
Lower Bound > Upper Bound.
InverseChiDistribution (inverse of chi-squared distribution)
Returns the inverse of the given cumulative Chi-squared distribution greater than or equal to a pre-specified value. This function is used to compare observed results against expected ones to assess the validity of a hypothesis.
For information on the Chi-squared function, see
ChiSquareDistribution, page 348
.
Syntax
InverseChiDistribution(x, df)
© 2012 MicroStrategy, Inc.
Statistical functions
369
4
Plug-In Package Functions MicroStrategy Functions Reference
Where:
•
x is the probability associated with a given chi-squared distribution.
•
df is the number of degrees of freedom for the distribution.
Usage notes
•
If df is not an integer, it is truncated
•
The following are invalid conditions:
Either argument is nonnumeric
x < 0 or x >1
df< 1
InverseFisher (inverse of the Fisher transformation)
Returns the inverse of the Fisher transformation. This function is used to analyze correlations between data arrays.
For information on the Fisher transformation function, see
Fisher (fisher transformation), page 355
.
Syntax
InverseFisher(x)
Where:
•
x is the value for which the inverse of the Fisher transformation is performed.
Expression
x = e
2y
– e
2y
+ 1
Usage notes
This function results in an invalid value if x is nonnumeric.
370
Statistical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
InverseFDistribution (inverse of F-probability distribution)
Returns the inverse of the F probability distribution. This function is used to return critical values from the F distribution. For example, the output of an analysis-of-variation (anova) calculation may include data for F-statistic,
F-probability, and F-critical values at the 0.05 level of significance. In such cases, the significance level can be used as the probability argument for FINV to return the critical value of F.
For information on the F probability distribution function, see
(f-probability distribution), page 356
Syntax
InverseFDistribution (x, df
1
, df
2
)
Where:
•
x is the probability associated with the F cumulative distribution.
•
df
1
represents the degrees of freedom of numerator values.
•
df
2
represents the degrees of freedom of denominator values.
Usage notes
•
If df
1
or df
2
is not an integer, it is truncated.
•
The following are invalid conditions:
An argument is nonnumeric.
x< 0 or x > 1.
df
1
< 1
df
2
< 1
InverseGammaDistribution (inverse of gamma distribution)
Returns the inverse of the cumulative Gamma distribution.
For more information on the cumulative Gamma distribution function, see
.
© 2012 MicroStrategy, Inc.
Statistical functions
371
4
Plug-In Package Functions MicroStrategy Functions Reference
Syntax
InverseGammaDistribution (x, Alpha, Beta)
Where:
•
x is the value at which you want to evaluate the distribution.
•
Alpha is a distribution parameter.
•
Beta is a distribution parameter.
Usage notes
The following are invalid conditions:
•
Either alpha or beta is nonnumeric.
•
Either alpha 0 or beta 0.
•
x < 0 or x > 1.
InverseLognormalDistribution (inverse of lognormal distribution)
Returns the inverse of the lognormal cumulative distribution.
Ln(x) is normally distributed using mean and standard deviation as parameters.
For more information on the lognormal cumulative distribution function, see
LognormalDistribution, page 376
Syntax
InverseLognormalDistribution(x, Mean, Stdev)
Where:
•
x is the probability associated with the lognormal distribution.
•
Mean is the mean of ln(x).
•
Stdev is the standard deviation of ln(x).
372
Statistical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Expression
In the expression that follows, mean =, stdev =
= e
+
InverseNormS p
Usage notes
The following are invalid conditions:
•
One of the arguments is nonnumeric.
•
x < 0.
•
x > 1.
•
stdev < 0.
InverseNormDistribution (inverse of normal cumulative distribution)
Returns the inverse of the normal cumulative distribution for a given mean and standard deviation.
For more information on the normal cumulative distribution function, see
NormalDistribution (normal cumulative distribution), page 379
Syntax
InverseNormDistribution(x, Mean, Stdev)
Where:
•
x is the probability corresponding to a given normal distribution.
•
Mean is the arithmetic mean of the distribution.
•
Stdev is the standard deviation of the distribution.
Usage notes
•
If mean = 0 and stdev = 1, this function returns the standard normal distribution
Statistical functions
373
© 2012 MicroStrategy, Inc.
4
Plug-In Package Functions
•
The following are invalid conditions:
One of the arguments is nonnumeric.
stdev
0.
MicroStrategy Functions Reference
InverseNormSDistribution (inverse of standard normal cumulative distribution)
Returns the inverse, or critical value, of the cumulative standard normal distribution.
This function computes the critical value so that the cumulative distribution is greater than or equal to a pre-specified value.
For more information on the cumulative standard normal distribution function, see
StandardNormalDistribution (standard normal cumulative distribution), page 386
Syntax
InverseNormSDistribution(x)
Where:
x is the probability corresponding to the normal distribution.
Usage notes
The following are invalid conditions:
•
x is nonnumeric.
•
x < 0 or x > 1.
InverseTDistribution (inverse of T-distribution)
Returns the inverse of the cumulative T-distribution.
For more information on the cumulative T-distribution function, see
374
Statistical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Syntax
InverseTDistribution(Probability, df)
Where:
•
Probability is the probability associated with the t-distribution.
•
df is a value that indicates the degrees of freedom of the distribution.
Expression
p t X
Where:
X is a random value that follows the t-distribution.
Usage notes
•
If df is not an integer, it is truncated.
•
The following are invalid conditions:
Either probability or df is nonnumeric.
Probability < 0 or probability > 1.
df < 1.
Kurtosis
Returns the kurtosis, or relative flatness, of the values in a given set of data.
Kurtosis characterizes the relative “peakedness” or “flatness” of a distribution when compared to a normal distribution. A positive kurtosis indicates a relatively peaked distribution, while a negative one signifies a relatively flat distribution.
Syntax
Kurtosis <FactID> (Argument)
Where:
•
Argument is a set of values represented by a fact or metric.
© 2012 MicroStrategy, Inc.
Statistical functions
375
4
Plug-In Package Functions MicroStrategy Functions Reference
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
Expression
In the expression that follows, s is the sample standard deviation.
–
+
x i s
–
4
–
3 n 1 n 2
–
2
LognormalDistribution
Returns the lognormal cumulative distribution of a random variable X, where the logarithm of X is normally distributed.
LognormalDistribution takes mean and standard deviation as parameters.
This function is used to analyze data that has been logarithmically transformed.
Syntax
LognormalDistribution(x, Mean, Stdev)
Where:
•
x is the value at which the function is evaluated.
•
Mean is the mean of ln(x).
•
Stdev is the standard deviation of ln(x).
Expression
In the expression that follows, mean =, stdev = .
= NORMSDIST
--------------
Usage notes
The following are invalid conditions:
•
One of the arguments is nonnumeric.
•
x 0.
•
stdev 0.
376
Statistical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
MeanTTest (mean T-test)
Calculates the P-value of a T-test that tests the mean of the data against a particular value. This function is used to determine the closeness in the value of the means of two samples coming from the same population.
Decision
Accept H
0
Reject H
0
Reality:
H
0
is correct
No problem
Type 2 error
Reality:
H
1
is correct
Type 1 error
No problem
Definition
P-value = Pr[Reject H
0
| H
0
is correct]
P-value is basically a probability of making a Type 2 error.
MeanTTest returns the p-value for the hypothesis test in the following form:
•
For H
0
:
(Argument) =
0
•
For H
1
:
(Argument) <
0
(Type = -1)
(Argument)
0
(Type = 0: two-sided test)
(Argument) >
0
(Type = 1)
(Argument)
0
(Type = 2: one-sided test)
Syntax
MeanTTest <Hypothesis type> (Argument, Hypothesis mean)
Where:
•
Argument is the value or list of values, represented by a fact or metric, that contains sample data.
•
Hypothesis mean is
0
.
•
Hypothesis type denotes the type of t-test to be performed.
Hypothesis type can be -1, 0, 1, or 2.
Statistical functions
377
© 2012 MicroStrategy, Inc.
4
Plug-In Package Functions MicroStrategy Functions Reference
NegativeBinomialDistribution
This function determines the probability that there will be F failures before the Nth success (S) with a constant probability of success P. The negative binomial distribution is similar to the binomial distribution, but the number of successes is fixed and the number of trials is variable.
As in the binomial distribution, trials are assumed to be independent. For example, to find ten individuals with excellent reflexes, knowing that the probability that a candidate has these qualifications is 0.3, this function calculates the probability that a certain number of unqualified candidates will be interviewed before the ten people sought are selected.
Syntax
NegativeBinomialDistribution(F, S, P)
Where:
•
F is the number of failures.
•
S is the threshold number of successes.
•
P is the probability of a success.
Expression
In the expression that follows, F = x, S = r.
=
+
P r
1 P
x
Usage notes
•
If either F or S is not an integer, it is truncated.
•
The following are invalid conditions:
One of the arguments is nonnumeric.
P< 0 or P> 1.
F + (S - 1) 0
378
Statistical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
NormalDistribution (normal cumulative distribution)
Calculates the normal distribution of the mean and standard deviation of a set of values. Returns either the cumulative distribution or the probability density.
This function is widely applied in statistics, including in the area of hypothesis testing.
Syntax
NormalDistribution <Cumulative> (x, Mean, Stdev)
Where:
•
x is the value for which the distribution is sought.
•
Mean is the arithmetic mean of the distribution.
•
stdev is the standard deviation of the distribution.
•
Cumulative is a logical value that determines the form of the function:
If Cumulative=0 (default), it returns the cumulative distribution.
If Cumulative=1 it returns the probability density.
Expression
In the expression that follows, z = x, mean = , stdev = .
= ---------- e
–
2
2
2
1
1
Usage notes
•
The following are invalid conditions:
Either mean or stdev is nonnumeric.
Stdev
0.
•
If mean = 0 and stdev = 1, the function returns the standard normal distribution.
© 2012 MicroStrategy, Inc.
Statistical functions
379
4
Plug-In Package Functions MicroStrategy Functions Reference
PairedTTest (paired T-test, two-sample for means)
Calculates the P-value of a T-test on the means of two paired sets of data.
Two-sample analyses are used to determine the level of variance between the means of paired samples.
Decision
Accept H
0
Reject H
0
Reality:
H
0
is correct
No problem
Type 2 error
Reality:
H
1
is correct
Type 1 error
No problem
Definition
P-value = Pr[Reject H
0
| H
0
is correct]
P-value is basically a probability of making a Type 2
PairedTTest returns the P-value for the hypothesis test in the following form:
•
H
0
:
([Argument1 – Argument2]) = Offset
•
H
1
:
([Argument1– Argument2]) <
Offset [Type = –1]
([Argument1– Argument2])
Offset [Type = 0: Two-sided test]
([Argument1– Argument2]) >
Offset [Type = 1]
([Argument1 – Argument2])
Offset [Type = 2: One-sided test]
Syntax
PairedTTest <Type, Offset> (Argument1, Argument2)
Where:
•
Argument1 is a fact or metric representing a set of sample values.
380
Statistical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
•
Argument2 is a fact or metric representing a set of sample values.
•
Type is a logical value that determines the form of the function.
Usage notes
One of the results of this sample is pooled variance, an accumulated measure of spread data about the mean. Pooled variance is calculated as:
S
2
= n n
1
1
2
1
+
+ n
2 n
2
–
S
2
2
2
Pearson (Pearson product moment correlation coefficient)
This function returns the Pearson product moment correlation coefficient of a set of values. The coefficient is a dimensionless index that ranges from -1.0 to 1.0 (inclusive). It is used to determine the extent of a relationship between two data sets.
Syntax
Pearson <FactID> (Argument1, Argument2)
Where:
•
Argument1 is a list of independent values represented by a fact or metric.
•
Argument2 is a list of dependent values represented by a fact or metric.
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
Expression
In the expression that follows, Argument1 = X, Argument2 = Y.
r =
nX n XY
2
–
X
–
2
X
2
–
Y
2
Usage notes
The following are invalid conditions:
•
Either Argument1 or Argument2 contains one or more null values.
© 2012 MicroStrategy, Inc.
Statistical functions
381
4
Plug-In Package Functions MicroStrategy Functions Reference
•
Argument1 and Argument2 contain a different number of data points.
Permut (permutation)
Returns the number of possible permutations for a given number of items selected as a group from a set.
In permutation calculations, the internal order of the items selected affects the return. This differs from calculations of combinations, in which the order of the items selected does not affect the return. Combination (Combine) is categorized as a mathematical function.
Syntax
Permut(Number, NumberChosen)
Where:
•
Number is the number of items in a set.
•
NumberChosen is the number of items selected for permutation.
Expression
In the expression that follows, Number = n; NumberChosen = k.
P =
n k
!
Usage notes
•
If an argument is not an integer, it is truncated.
•
This function returns an error value if:
Either argument is nonnumeric.
Number < 0.
NumberChosen < 0.
Number
NumberChosen.
PoissonDistribution
Returns the Poisson distribution of a random variable. This function predicts the number of identified events to take place over a specified period. For
382
Statistical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4 example, it can predict the number of cars to arrive at a toll plaza in a one-minute interval.
Syntax
PoissonDistribution <Cumulative> (x, lambda)
Where:
•
x is the number of events in the prediction.
•
lambda is the expected numeric value of the expression.
•
Cumulative is a logical value that determines the form of the probability distribution returned:
If Cumulative = 0 (default), the function returns the probability that the number of random events will be between 0 and x.
If Cumulative = 1, the function returns the probability that the number of random events will be exactly x.
Expression
•
For type = 1:
POISSON = e
–
x!
x
•
For type = 0:
CUMPOISSON = x
k = 0 e
–
k!
k
--------
Usage notes
•
If x is not an integer, it is truncated.
•
The following are invalid conditions:
x or lambda is nonnumeric.
x
0.
lambda
0.
© 2012 MicroStrategy, Inc.
Statistical functions
383
4
Plug-In Package Functions MicroStrategy Functions Reference
RSquare (square of pearson product moment correlation coefficient)
Returns the square of the Pearson product moment correlation coefficient for a set of values. RSquare gives the proportion of the variance in y that is attributable to the variance in x.
Syntax
RSquare <FactID> (Argument1, Argument2)
Where:
•
Argument1 is a list of data-point coordinates.
•
Argument2 is a list of data point coordinates.
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
Usage notes
The following are invalid conditions:
•
Argument1 and Argument2 have a different number of values.
•
Either Argument1 or Argument2 contains one or more NULL values.
Skew
Returns the skewness of a data set in a given list of values.
Skewness is the degree of asymmetry of a distribution in relation to its mean. A positive skewness indicates asymmetry biased towards positive values, while a negative skewness indicates the opposite.
Syntax
Skew <FactID> (Argument)
Where:
•
Argument is a fact or metric representing a list of values.
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
384
Statistical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Expression
In the expression that follows, s is the sample standard deviation.
3
n
–
x i s
–
Slope (of a linear regression)
Returns the slope of a linear regression line.
In a regression line passing through a set of data points in data sets Argument1 and Argument2, the slope is the vertical distance divided by the horizontal distance between any two points on the line. This ratio is also known as the rate of change along the line.
Syntax
Slope <FactID> (Argument1, Argument2)
Where:
•
Argument1 is a fact or metric containing numerically dependent (y) data points.
•
Argument2 is a fact or metric containing numerically independent (x) data points.
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
Expression
b = n
xy
–
-----------------------------n
– x
2
x
y
-
x
Usage notes
The following are invalid conditions:
•
Either Argument1 or Argument2 contains NULL values.
•
Argument1 and Argument2 have a different number of values.
© 2012 MicroStrategy, Inc.
Statistical functions
385
4
Plug-In Package Functions MicroStrategy Functions Reference
Example
For an example using the Slope function, see
Standardize
Returns a normalized value from a distribution characterized by a mean and standard deviation.
Syntax
Standardize(x, Mean, Stdev)
Where:
•
x is the value you want to normalize.
•
Mean is the arithmetic mean of the distribution.
•
Stdev is the standard deviation of the distribution.
Expression
Z =
Usage notes
The following is an invalid condition:
•
Stdev
0
StandardNormalDistribution (standard normal cumulative distribution)
Returns the cumulative distribution of a standard normal variable. The mean is 0 and the standard deviation is 1. This function can be used in lieu of a table of standard normal curve areas.
Syntax
StandardNormalDistribution (Argument)
386
Statistical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Where:
Argument is a metric representing a list of numbers.
Expression
=
2
– z
2
2
Usage notes
This function results in an invalid value if Argument is nonnumeric.
SteYX (standard error of estimates)
Returns the standard error of estimates in linear regression with two variables (for example, Y = Intercept + Slope * X).
Syntax
SteYX([Y], [X])
Where:
•
Y is an array or range of dependent data points.
•
X is an array or range of independent data points.
Expression
S
=
1
y
2
–
y
2
–
n
n xy
– x
2
–
x
x
y
2
-----------------------------------
2
Usage notes
•
If an argument value contains text, logical values, or empty cells, those values are ignored; however, cells with the value zero are included.
•
It is an invalid condition for Y and X to be empty or have a different number of data points.
© 2012 MicroStrategy, Inc.
Statistical functions
387
4
Plug-In Package Functions MicroStrategy Functions Reference
TDistribution
Returns the cumulative distribution of a random variable.
This function can be used in lieu of a table of critical values to test hypotheses on small sample sets.
Syntax
TDistribution(x, df)
Where:
•
x is the numeric value at which the distribution is evaluated.
•
df is a value that indicates the degrees of freedom of the distribution.
Expression
p x X
Where:
•
X is a random value that follows the t-distribution.
Usage notes
•
If df is not an integer, it is truncated.
•
The following are invalid conditions:
Either x or df is nonnumeric.
df < 1.
Trend
The Trend function uses data recorded for certain time intervals to calculate and display the expected value of data for an unknown time period. This is most commonly used to predict future metric values based on historical data.
For example, based on revenue data for three years, you want to predict what your Revenue will be for the coming year.
This function uses a linear equation to predict future values. Therefore, it is best suited to predict values that increase or decrease in a linear trend. For example, if your profits are increasing by $10,000 each year, this is a scenario that is well suited for a prediction based on a linear equation.
388
Statistical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
For a function that predicts values in a similar way for data that is increasing
or decreasing exponentially, see
GrowthV (growth, vector input), page 363
Syntax
Trend <FactID, SortBy>
(KnownData1,...,KnownDataN, FutureTimeOffset)
Where:
•
KnownData1,...,KnownDataN are separate scalar values that provide the data to use to predict a future value for. While you can use Trend to enter these values manually, it is more common to use TrendV which can use a metric to enter a list of values, as described in
TrendV (trend, vector input), page 389
.
•
FutureTimeOffset is the point in time after the final time interval available for which to predict the data. This is commonly defined as an integer. For example, to predict values for the year 2009 when the last available data you have is for 2007, you would enter the value of 2 for
FutureTimeOffset.
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
•
SortBy is a parameter that defines the order of calculation. For more information, see
BreakBy and SortBy parameters, page 19
Example
As described in the syntax requirements, you can use Trend to enter values manually. However, it is more common to use TrendV to use metrics and
attributes to enter this information, as described in
TrendV (trend, vector input), page 389
.
TrendV (trend, vector input)
The TrendV function uses data recorded for certain time intervals to calculate and display the expected value of data for an unknown time period.
This is most commonly used to predict future metric values based on
© 2012 MicroStrategy, Inc.
Statistical functions
389
4
Plug-In Package Functions MicroStrategy Functions Reference historical data. For example, based on revenue data for three years, you want to predict what your Revenue will be for the coming year.
You can use TrendV to predict values for any point in time, including dates that have known data. However, this type of function is meant for predicting future, unknown values.
This function uses a linear equation to predict future values. Therefore, it is best suited to predict values that increase or decrease in a linear trend. For example, if your profits are increasing by $10,000 each year, this is a scenario that is well suited for a prediction based on a linear equation.
For a function that predicts values in a similar way for data that is increasing
or decreasing exponentially, see
GrowthV (growth, vector input), page 363
Syntax
TrendV <FactID, SortBy>(KnownData, FutureTimeOffset)
Where:
•
KnownData is an object representing a list of values. This list of values is the known data to use to predict a future value for. KnownData is commonly used for metrics that represent data such as revenue, profit, and so on.
•
FutureTimeOffset is the point in time after the final time interval available for which to predict the data. This is commonly defined as an integer. For example, to predict values for the year 2009 when the last available data you have is for 2007, you would enter the value of 2 for
FutureTimeOffset.
The TrendV function assumes that data is available for sequential time intervals with no missing data. If your data meets these requirements, this allows you to use a single expression to use on reports with varying time intervals such as year, month, quarter, and so on. This is an advantage of TrendV in relation to ForecastV, which requires you to specify a time interval such as year for each expression. For an example, see the examples described below.
•
FactID is a parameter that forces a calculation to take place on a fact table that contains the selected fact.
•
SortBy is a parameter that defines the order of calculation. For more information, see
BreakBy and SortBy parameters, page 19
390
Statistical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
Example
The TrendV function is useful to display predicted future values of a metric as a subtotal of the metric on a report.
For example, in the MicroStrategy Tutorial project a new subtotal named
2008 Trend can be created with the following definition:
TrendV(x, 1)
Since this is in a subtotal, the x is a placeholder for a metric. When a subtotal is applied to a metric on a report, the placeholder inputs that metric’s values.
Also, 1 is used as the offset in the time interval to predict data for the first time interval that is not known.
After making the new custom subtotal available for the Revenue metric (see the Advanced Reporting Guide for steps to make custom subtotals available for metrics) a report with the attribute Year and the metric Revenue is created. When the 2008 Trend is displayed on the report, it displays the predicted value for 2008 Revenue, as shown below:
This value is the same value predicted in the example using ForecastV, as described in
ForecastV (forecast, vector input), page 358
. The advantage of using TrendV is that since you do not have to define the attribute or other object that defines the time interval, you can switch the time interval used by modifying the report. For example, the report can be modified to display
© 2012 MicroStrategy, Inc.
Statistical functions
391
4
Plug-In Package Functions MicroStrategy Functions Reference
Quarter instead of Year, which allows the 2008 Trend subtotal to predict the revenue for the first quarter of 2008. This is shown in the report below.
The type of subtotal shown above could also be created using
ForecastV, but it would require you to create a separate subtotal that used the Quarter attribute to define the time intervals.
VarTest (variance test)
Returns the P-value of a test that tests the variance of the data against a particular value.
Decision
Accept H
0
Reject H
0
Reality:
H
0
is correct
No problem
Type 2 error
Reality:
H
1
is correct
Type 1 error
No problem
Definition
P-value = Pr[Reject H
0
| H
0 is correct]
P-value is basically a probability of making a Type 2 error.
VarTest returns the P-value for the hypothesis test in the following form:
•
H
0
:
2
(Argument) =
2
0
392
Statistical functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference Plug-In Package Functions 4
•
H
1
:
2
(Argument) <
0
2
[Type = –1]
(Argument)
2
0
[Type = 0: Two-sided test]
(Argument) >
2
0
0
[Type = 1]
(Argument)
2
0
[Type = 2: One-sided test]
Syntax
VarTest <Hypothesis Type> (Argument, Hypothesis
Variance)
Where:
•
Hypothesis Type is the parameter to set whether you are testing the probability of the value being equal (0), less than (-1), greater than (1), or not equal to (2) the sigma or variance.
•
Argument is a fact or metric representing the values you are testing.
•
Hypothesis Variance is the variance you are testing.
Example
VarTest(M1, 1000) = 1000
For a set of values (M1), what is the probability that the variance of the value will be equal to 1000? Note that M1 needs to have a defined dimensionality.
Usage notes
For each variance test function, two tests are performed. The first tests the probability of the value being equal (0), and the second tests the probability of the value being less than (-1), greater than (1), or not equal to (2) the sigma or variance. A parameter must be specified for the second test.
WeibullDistribution
Returns either the cumulative distribution or the probability density of a random variable. Used in reliability analysis, such as the calculation of the mean time to failure for a given device.
© 2012 MicroStrategy, Inc.
Statistical functions
393
4
Plug-In Package Functions MicroStrategy Functions Reference
Syntax
WeibullDistribution <Cumulative> (x, Alpha, Beta)
Where:
•
x is the numeric value at which the distribution is evaluated.
•
Alpha is a distribution parameter.
•
Beta is a distribution parameter.
•
Cumulative is a logical value that determines the form of the function:
If Cumulative=0 (default), it returns the cumulative distribution.
If Cumulative=1, it returns the probability density.
Expression
•
For the Weibull cumulative distribution:
= 1 e
–
x
•
For the Weibull probability density:
=
–
x
e
•
When alpha = 1, the Weibull exponential return is
=
Usage notes
The following are invalid conditions:
•
alpha or beta is nonnumeric.
•
x < 0.
•
alpha < 0.
•
beta < 0.
394
Statistical functions © 2012 MicroStrategy, Inc.
A.
M
ICRO
S
TRATEGY AND
D
ATABASE
S
UPPORT FOR
F
UNCTIONS
A
Introduction
The functions provided with MicroStrategy can be evaluated by the
MicroStrategy Analytical Engine or passed to the database for processing.
The sections and tables in this appendix list MicroStrategy Analytical Engine and database support for MicroStrategy functions. Reviewing this support allows you to determine whether a MicroStrategy function can be supported for your MicroStrategy environment.
•
Analytical Engine support for functions, page 395
•
Databases that a function can be evaluated on, page 398
For additional information on how functions are processed, see
Analytical Engine support for functions
The functions listed in the table below are supported by the MicroStrategy
Analytical Engine. This allows metrics to be evaluated by MicroStrategy in
© 2012 MicroStrategy, Inc.
Analytical Engine support for functions
395
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type
Basic functions cases where functions cannot be evaluated by a database. It also allows metrics to support smart metric functionality (see the Advanced Reporting
Guide).
Date and time functions
Internal functions
Null and Zero functions
Functions supported by the MicroStrategy Analytical
Engine
• Add
• Average
• Avg
• Count
• First
• Geomean
• Greatest
• Last
• Least
• Max
• Median
• Min
• Mode
• Multiply
• Product
• Stdev
• StdevP
• Sum
• Var
• VarP
All date and time functions must be evaluated by the database, and therefore are not supported by the MicroStrategy Analytical
Engine. To review database support for functions, see
Databases that a function can be evaluated on, page 398
• Banding
• BandingC
• BandingP
• Case
• CaseV
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
396
Analytical Engine support for functions © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
MicroStrategy and Database Support for Functions A
Functions supported by the MicroStrategy Analytical
Engine
• ExpWghMovingAvg
• ExpWghRunningAvg
• FirstInRange
• Lag
• LastInRange
• Lead
• MovingAvg
• MovingCount
• MovingDifference
• MovingMax
• MovingMin
• MovingStdev
• MovingStdevP
• MovingSum
• OLAPAvg
• OLAPCount
• OLAPMax
• OLAPMin
• OLAPSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningStdev
• RunningStdevP
• RunningSum
• NTile
• NTileSize
• NTileValue
• NTileValueSize
• Percentile
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• Upper
• All Arithmetic functions are supported by the MicroStrategy
Analytical Engine
© 2012 MicroStrategy, Inc.
Analytical Engine support for functions
397
A
MicroStrategy and Database Support for Functions
Function type
Comparison operators
Comparison operators for rank
Logical operators
Data mining functions
Financial functions
Mathematical functions
Statistical functions
MicroStrategy Functions Reference
Functions supported by the MicroStrategy Analytical
Engine
• <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
• *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
• AND
• IF
• Not
• Or
All data mining functions are supported by the MicroStrategy
Analytical Engine.
All financial functions are supported by the MicroStrategy
Analytical Engine.
All mathematical functions are supported by the MicroStrategy
Analytical Engine.
All statistical functions are supported by the MicroStrategy
Analytical Engine.
Databases that a function can be evaluated on
The tables below list the function support for each database that is certified for use with MicroStrategy. If a function is listed for a database, the function can be evaluated within that database. If a function cannot be evaluated
398
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A within a database, the function may be able to be supported by the
MicroStrategy Analytical Engine (see
Analytical Engine support for functions, page 395
Except where explicitly stated, only database that are certified to work with
MicroStrategy are listed below. For information on the certification and support for databases, refer to the MicroStrategy Readme:
•
•
•
•
•
•
•
•
•
Microsoft SQL Server, page 445
•
•
•
•
•
•
•
•
•
•
•
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
399
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Aster nCluster
The tables listed below describe the MicroStrategy function support for Aster nCluster databases:
•
Aster nCluster 4.6.x, page 400
Aster nCluster 4.6.x
Function type
Basic functions
Date and time functions
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Greatest
• Least
• Max
• Min
• Multiply
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
400
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type
Internal functions
Null and Zero functions
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Functions that can be evaluated on the database
• Concat
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• Upper
• -
• x
• +
• /
• U-
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
• Lag
• Lead
• MovingAvg
• MovingCount
• MovingMax
• MovingMin
• MovingSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningSum
• Rank
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
401
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions
Financial functions
None
None
402
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Mathematical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Degrees
• Exp
• Floor
• Int
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Round
• Round2
• Sin
• Sqrt
• Tan
• Trunc
None Statistical functions
EXASolution
The tables listed below describe the MicroStrategy function support for
EXASolution databases:
•
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
403
A
MicroStrategy and Database Support for Functions
EXASolution 4.x
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Greatest
• Least
• Max
• Median
• Min
• Multiply
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
404
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Comparison operators
Functions that can be evaluated on the database
• Concat
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• -
• x
• +
• /
• U-
• Lag
• Lead
• MovingAvg
• MovingCount
• MovingMax
• MovingMin
• MovingSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningSum
• Rank
• <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
405
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions
Financial functions
Mathematical functions
Statistical functions
None
None
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Degrees
• Exp
• Floor
• Int
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Round
• Round2
• Sin
• Sinh
• Sqrt
• Tan
• Tanh
• Trunc
• Correlation
• Intercept
• RSquare
• Slope
406
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Greenplum
The tables listed below describe the MicroStrategy function support for
Greenplum databases:
•
Greenplum 4.x
Function type
Basic functions
Date and time functions
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Greatest
• Least
• Max
• Min
• Multiply
• Product
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Year
• YearEndDate
• YearStartDate
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
407
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type
Internal functions
Null and Zero functions
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Comparison operators
Functions that can be evaluated on the database
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
None
None
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• Upper
• -
• x
• +
• /
• U-
• <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
408
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type Functions that can be evaluated on the database
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions
Financial functions
Mathematical functions
Statistical functions
None
None
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Degrees
• Exp
• Floor
• Int
• Int2
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Randbetween
• Round
• Round2
• Sin
• Sqrt
• Tan
• Trunc
• Correlation
• Covariance
• Intercept
• RSquare
• Slope
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
409
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Hadoop Hive
The tables listed below describe the MicroStrategy function support for
Hadoop Hive databases:
•
Hadoop Hive 0.7.x
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
OLAP functions
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• First
• Geomean
• Greatest
• Last
• Least
• Max
• Min
• Multiply
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DaysBetween
• Hour
• Minute
• Month
• Second
• Week
• Year
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
None
410
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type Functions that can be evaluated on the database
Rank and NTile functions
String functions
Arithmetic operators
Comparison operators
None
• Concat
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• Upper
• -
• x
• +
• /
• U-
• <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions None
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
411
A
MicroStrategy and Database Support for Functions
Function type
Financial functions
Mathematical functions
Statistical functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
None
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atanh
• Ceiling
• Cos
• Degrees
• Exp
• Floor
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Round
• Round2
• Sin
• Sinh
• Sqrt
• Tan
• Tanh
• Covariance
• Standardize
IBM DB2
The tables listed below describe the MicroStrategy function support for IBM
DB2 databases:
•
DB2 UDB V9.5 for Linux, UNIX, and Windows, page 413
•
DB2 UDB V9.7 for Linux, UNIX, and Windows, page 417
•
DB2 UDB V10.1 for Linux, UNIX, and Windows, page 421
•
•
412
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
DB2 UDB V9.5 for Linux, UNIX, and Windows
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Max
• Min
• Multiply
• Product
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
413
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Functions that can be evaluated on the database
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• Upper
• -
• x
• +
• /
• U-
• Lag
• Lead
• MovingAvg
• MovingCount
• MovingMax
• MovingMin
• MovingStdev
• MovingStdevP
• MovingSum
• OLAPAvg
• OLAPCount
• OLAPMax
• OLAPMin
• OLAPRank
• OLAPSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningStdev
• RunningStdevP
• RunningSum
414
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type Functions that can be evaluated on the database
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions
Financial functions
None
None
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
415
A
MicroStrategy and Database Support for Functions
Function type
Mathematical functions
Statistical functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Cosh
• Degrees
• Exp
• Floor
• Int
• Int2
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Randbetween
• Round
• Round2
• Sin
• Sinh
• Sqrt
• Tan
• Tanh
• Trunc
• Correlation
• Covarience
• Intercept
• RSquare
• Slope
416
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
DB2 UDB V9.7 for Linux, UNIX, and Windows
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Max
• Min
• Multiply
• Product
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
417
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Functions that can be evaluated on the database
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• Upper
• -
• x
• +
• /
• U-
• Lag
• Lead
• MovingAvg
• MovingCount
• MovingMax
• MovingMin
• MovingStdev
• MovingStdevP
• MovingSum
• OLAPAvg
• OLAPCount
• OLAPMax
• OLAPMin
• OLAPRank
• OLAPSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningStdev
• RunningStdevP
• RunningSum
418
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type Functions that can be evaluated on the database
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions
Financial functions
None
None
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
419
A
MicroStrategy and Database Support for Functions
Function type
Mathematical functions
Statistical functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Cosh
• Degrees
• Exp
• Floor
• Int
• Int2
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Randbetween
• Round
• Round2
• Sin
• Sinh
• Sqrt
• Tan
• Tanh
• Trunc
• Correlation
• Covarience
• Intercept
• RSquare
• Slope
420
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
DB2 UDB V10.1 for Linux, UNIX, and Windows
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Max
• Min
• Multiply
• Product
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
421
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Functions that can be evaluated on the database
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• Upper
• -
• x
• +
• /
• U-
• Lag
• Lead
• MovingAvg
• MovingCount
• MovingMax
• MovingMin
• MovingStdev
• MovingStdevP
• MovingSum
• OLAPAvg
• OLAPCount
• OLAPMax
• OLAPMin
• OLAPRank
• OLAPSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningStdev
• RunningStdevP
• RunningSum
422
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type Functions that can be evaluated on the database
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions
Financial functions
None
None
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
423
A
MicroStrategy and Database Support for Functions
Function type
Mathematical functions
Statistical functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Cosh
• Degrees
• Exp
• Floor
• Int
• Int2
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Randbetween
• Round
• Round2
• Sin
• Sinh
• Sqrt
• Tan
• Tanh
• Trunc
• Correlation
• Covariance
• Intercept
• RSquare
• Slope
424
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
DB2 for i 6.1
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
OLAP functions
Rank and NTile functions
© 2012 MicroStrategy, Inc.
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Max
• Min
• Multiply
• Product
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
None
• Rank
Databases that a function can be evaluated on
425
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
String functions
Arithmetic operators
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• Upper
• -
• x
• +
• /
• U-
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators
Data mining functions
• AND
• IF
• Not
• Or
None
426
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Financial functions
Mathematical functions
Statistical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
None
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Cosh
• Degrees
• Exp
• Floor
• Int
• Int2
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Randbetween
• Round
• Round2
• Sin
• Sinh
• Sqrt
• Tan
• Tanh
• Trunc
None
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
427
A
MicroStrategy and Database Support for Functions
DB2 for i 7.1
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
OLAP functions
Rank and NTile functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Max
• Min
• Multiply
• Product
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
None
• Rank
428
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type Functions that can be evaluated on the database
String functions
Arithmetic operators
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• Upper
• -
• x
• +
• /
• U-
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators
Data mining functions
• AND
• IF
• Not
• Or
None
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
429
A
MicroStrategy and Database Support for Functions
Function type
Financial functions
Mathematical functions
Statistical functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
None
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Cosh
• Degrees
• Exp
• Floor
• Int
• Int2
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Randbetween
• Round
• Round2
• Sin
• Sinh
• Sqrt
• Tan
• Tanh
• Trunc
None
Infobright
The tables listed below describe the MicroStrategy function support for
Infobright databases:
•
430
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Infobright 4.0.x
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
OLAP functions
© 2012 MicroStrategy, Inc.
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Greatest
• Least
• Max
• Min
• Multiply
• Product
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
None
Databases that a function can be evaluated on
431
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
Rank and NTile functions
String functions
Arithmetic operators
Comparison operators
None
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• Upper
• -
• x
• +
• /
• U-
• <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
432
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Data mining functions
Financial functions
Mathematical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
None
None
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Cosh
• Degrees
• Exp
• Floor
• Int
• Int2
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Randbetween
• Round
• Round2
• Sin
• Sinh
• Sqrt
• Tan
• Tanh
• Trunc
None Statistical functions
Informix
The tables listed below describe the MicroStrategy function support for
Informix databases:
•
Informix IDS 11.5 and Informix Ultimate Edition 11.7, page 434
•
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
433
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Informix IDS 11.5 and Informix Ultimate Edition 11.7
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
OLAP functions
Rank and NTile functions
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Max
• Min
• Multiply
• Stdev
• Sum
• Var
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
None
None
434
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type Functions that can be evaluated on the database
String functions
Arithmetic operators
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• RightStr
• RTrim
• SubStr
• Trim
• -
• x
• +
• /
• U-
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators
Data mining functions
Financial functions
• AND
• IF
• Not
• Or
None
None
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
435
A
MicroStrategy and Database Support for Functions
Function type
Mathematical functions
Statistical functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Abs
• Acos
• Asin
• Atan
• Atan2
• Ceiling
• Cos
• Exp
• Floor
• Int
• Int2
• Ln
• Log10
• Mod
• Power
• Quotient
• Round
• Round2
• Sin
• Sqrt
• Tan
• Trunc
None
436
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Informix XPS 8.x
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
OLAP functions
Rank and NTile functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Max
• Min
• Multiply
• Stdev
• Sum
• Var
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
None
None
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
437
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
String functions
Arithmetic operators
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• RightStr
• RTrim
• SubStr
• Trim
• -
• x
• +
• /
• U-
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators
Data mining functions
Financial functions
• AND
• IF
• Not
• Or
None
None
438
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Mathematical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Abs
• Acos
• Asin
• Atan
• Atan2
• Ceiling
• Cos
• Exp
• Floor
• Int
• Int2
• Ln
• Log10
• Mod
• Power
• Round
• Round2
• Sin
• Sqrt
• Tan
• Trunc
None Statistical functions
Microsoft Access
The tables listed below describe the MicroStrategy function support for
Microsoft Access databases. Microsoft Access database are:
•
Microsoft Access 2000, 2002, or 2003, page 440
•
Microsoft Access 2007, page 443
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
439
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Microsoft Access 2000, 2002, or 2003
Microsoft Access 2000, 2002, or 2003 are only supported for demonstration purposes.
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
OLAP functions
Rank and NTile functions
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Max
• Min
• Multiply
• Sum
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
None
None
440
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type Functions that can be evaluated on the database
String functions
Arithmetic operators
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• Position
• RightStr
• SubStr
• Trim
• Upper
• -
• x
• +
• /
• U-
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators
Data mining functions
Financial functions
• AND
• IF
• Not
• Or
None
None
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
441
A
MicroStrategy and Database Support for Functions
Function type
Mathematical functions
Statistical functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Floor
• Int
• Int2
• Ln
• Mod
• Quotient
None
442
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Microsoft Access 2007
Microsoft Access 2007 is only supported for demonstration purposes.
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
OLAP functions
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Max
• Min
• Multiply
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• Millisecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
None
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
443
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
Rank and NTile functions
String functions
Arithmetic operators
Comparison operators
None
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• Upper
• -
• x
• +
• /
• U-
• <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
444
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Data mining functions
Financial functions
Mathematical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
None
None
• Abs
• Cos
• Exp
• Floor
• Int
• Int2
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Round
• Round2
• Sin
• Sqrt
• Tan
None Statistical functions
Microsoft SQL Server
The tables listed below describe the MicroStrategy function support for
Microsoft SQL Server databases:
•
Microsoft SQL Server 2000, page 446
•
Microsoft SQL Server 2005, page 449
•
Microsoft SQL Server 2008, page 452
•
Microsoft SQL Server 2008 R2 Parallel Data Warehouse, page 455
•
Microsoft SQL Server 2012, page 458
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
445
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Microsoft SQL Server 2000
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
OLAP functions
Rank and NTile functions
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Max
• Min
• Multiply
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
None
None
446
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type Functions that can be evaluated on the database
String functions
Arithmetic operators
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• Upper
• -
• x
• +
• /
• U-
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators
Data mining functions
• AND
• IF
• Not
• Or
None
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
447
A
MicroStrategy and Database Support for Functions
Function type
Financial functions
Mathematical functions
Statistical functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
None
• Abs
• Acos
• Asin
• Atan
• Atan2
• Ceiling
• Cos
• Degrees
• Exp
• Floor
• Int
• Int2
• Ln
• Log10
• Mod
• Power
• Quotient
• Radians
• Round
• Round2
• Sin
• Sqrt
• Tan
• None
448
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Microsoft SQL Server 2005
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
OLAP functions
Rank and NTile functions
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Max
• Min
• Multiply
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
• OLAPRank
• Rank
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
449
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
String functions
Arithmetic operators
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• Upper
• -
• x
• +
• /
• U-
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators
Data mining functions
• AND
• IF
• Not
• Or
None
450
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Financial functions
Mathematical functions
Statistical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
None
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Degrees
• Exp
• Floor
• Int
• Int2
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Randbetween
• Round
• Round2
• Sin
• Sqrt
• Tan
• Trunc
None
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
451
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Microsoft SQL Server 2008
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
OLAP functions
Rank and NTile functions
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Max
• Min
• Multiply
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
• OLAPRank
• Rank
452
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type Functions that can be evaluated on the database
String functions
Arithmetic operators
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• Upper
• -
• x
• +
• /
• U-
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators
Data mining functions
• AND
• IF
• Not
• Or
None
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
453
A
MicroStrategy and Database Support for Functions
Function type
Financial functions
Mathematical functions
Statistical functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
None
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Degrees
• Exp
• Floor
• Int
• Int2
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Randbetween
• Round
• Round2
• Sin
• Sqrt
• Tan
• Trunc
None
454
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Microsoft SQL Server 2008 R2 Parallel Data Warehouse
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
OLAP functions
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Max
• Min
• Multiply
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
• Lag
• Lead
• OLAPRank
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
455
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
Rank and NTile functions
String functions
Arithmetic operators
Comparison operators
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• Upper
• -
• x
• +
• /
• U-
• <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
456
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Data mining functions
Financial functions
Mathematical functions
Statistical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
None
None
• Abs
• Acosh
• Asin
• Asinh
• Atan
• Atanh
• Ceiling
• Cos
• Exp
• Floor
• Int
• Int2
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Round
• Round2
• Sin
• Sqrt
• Tan
• Trunc
None
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
457
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Microsoft SQL Server 2012
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Max
• Min
• Multiply
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
458
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Functions that can be evaluated on the database
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• -
• x
• +
• /
• U-
• Lag
• LastInRange
• Lead
• MovingAvg
• MovingCount
• MovingMax
• MovingMin
• MovingStdev
• MovingStdevP
• MovingSum
• OLAPAvg
• OLAPCount
• OLAPMax
• OLAPMin
• OLAPRank
• OLAPSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningStdev
• RunningStdevP
• RunningSum
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
459
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions
Financial functions
None
None
460
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Mathematical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atanh
• Atan2
• Ceiling
• Cos
• Exp
• Floor
• Int
• Int2
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Round
• Round2
• Sin
• Sqrt
• Tan
• Trunc
None Statistical functions
MySQL
The tables listed below describe the MicroStrategy function support forMySQL databases:
•
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
461
A
MicroStrategy and Database Support for Functions
MySQL 5.x
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
OLAP functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Greatest
• Least
• Max
• Min
• Multiply
• Product
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
None
462
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type Functions that can be evaluated on the database
Rank and NTile functions
String functions
Arithmetic operators
Comparison operators
None
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• Upper
• -
• x
• +
• /
• U-
• <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
463
A
MicroStrategy and Database Support for Functions
Function type
Data mining functions
Financial functions
Mathematical functions
Statistical functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
None
None
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Degrees
• Exp
• Floor
• Int
• Int2
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Randbetween
• Round
• Round2
• Sin
• Sqrt
• Tan
• Trunc
None
Netezza
The tables listed below describe the MicroStrategy function support for
Netezza databases:
•
•
464
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Netezza 5.0
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Max
• Min
• Multiply
• Product
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
465
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Functions that can be evaluated on the database
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• -
• x
• +
• /
• U-
• FirstInRange
• Lag
• LastInRange
• Lead
• MovingAvg
• MovingCount
• MovingMax
• MovingMin
• MovingStdev
• MovingStdevP
• MovingSum
• OLAPAvg
• OLAPCount
• OLAPMax
• OLAPMin
• OLAPRank
• OLAPSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningStdev
• RunningStdevP
• RunningSum
466
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type Functions that can be evaluated on the database
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions
Financial functions
None
None
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
467
A
MicroStrategy and Database Support for Functions
Function type
Mathematical functions
Statistical functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Cosh
• Degrees
• Exp
• Floor
• Int
• Int2
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Randbetween
• Round
• Round2
• Sin
• Sinh
• Sqrt
• Tan
• Tanh
• Trunc
• Correlation
• Covariance
• Fisher
• Intercept
• InverseFisher
• Pearson
• RSquare
• Skew
• Slope
• Standardize
• SteYX
468
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Netezza 6.0
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Max
• Min
• Multiply
• Product
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
469
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Functions that can be evaluated on the database
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• -
• x
• +
• /
• U-
• FirstInRange
• Lag
• LastInRange
• Lead
• MovingAvg
• MovingCount
• MovingMax
• MovingMin
• MovingStdev
• MovingStdevP
• MovingSum
• OLAPAvg
• OLAPCount
• OLAPMax
• OLAPMin
• OLAPRank
• OLAPSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningStdev
• RunningStdevP
• RunningSum
470
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type Functions that can be evaluated on the database
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions
Financial functions
None
None
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
471
A
MicroStrategy and Database Support for Functions
Function type
Mathematical functions
Statistical functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Cosh
• Degrees
• Exp
• Floor
• Int
• Int2
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Randbetween
• Round
• Round2
• Sin
• Sinh
• Sqrt
• Tan
• Tanh
• Trunc
• Correlation
• Covariance
• Fisher
• Intercept
• InverseFisher
• Kurtosis
• Pearson
• RSquare
• Skew
• Slope
• Standardize
• SteYX
472
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Oracle
MicroStrategy and Database Support for Functions A
The tables listed below describe the MicroStrategy function support for
Oracle databases:
•
•
•
•
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
473
A
MicroStrategy and Database Support for Functions
Oracle 10g
Function type
Basic functions
Date and time functions
Internal functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• First
• Geomean
• Greatest
• Last
• Least
• Max
• Median
• Min
• Multiply
• Product
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
474
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type
Null and Zero functions
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Functions that can be evaluated on the database
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
• FirstInRange
• Lag
• LastInRange
• Lead
• MovingAvg
• MovingCount
• MovingMax
• MovingMin
• MovingStdev
• MovingStdevP
• MovingSum
• OLAPAvg
• OLAPCount
• OLAPMax
• OLAPMin
• OLAPRank
• OLAPSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningStdev
• RunningStdevP
• RunningSum
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• -
• x
• +
• /
• U-
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
475
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions
Financial functions
None
None
476
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Mathematical functions
Statistical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Round
• Round2
• Sin
• Sinh
• Sqrt
• Tan
• Tanh
• Trunc
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Cosh
• Degrees
• Exp
• Floor
• Int
• Int2
• Correlation
• Covarience
• Fisher
• Intercept
• InverseFisher
• Kurtosis
• Pearson
• RSquare
• Skew
• Slope
• Standardize
• SteYX
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
477
A
MicroStrategy and Database Support for Functions
Oracle 10gR2
Function type
Basic functions
Date and time functions
Internal functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• First
• Geomean
• Greatest
• Last
• Least
• Max
• Median
• Min
• Multiply
• Product
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
478
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type
Null and Zero functions
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Functions that can be evaluated on the database
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
• FirstInRange
• Lag
• LastInRange
• Lead
• MovingAvg
• MovingCount
• MovingMax
• MovingMin
• MovingStdev
• MovingStdevP
• MovingSum
• OLAPAvg
• OLAPCount
• OLAPMax
• OLAPMin
• OLAPRank
• OLAPSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningStdev
• RunningStdevP
• RunningSum
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• -
• x
• +
• /
• U-
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
479
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions
Financial functions
None
None
480
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Mathematical functions
Statistical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Round
• Round2
• Sin
• Sinh
• Sqrt
• Tan
• Tanh
• Trunc
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Cosh
• Degrees
• Exp
• Floor
• Int
• Int2
• Correlation
• Covariance
• Fisher
• Intercept
• InverseFisher
• Kurtosis
• Pearson
• RSquare
• Skew
• Slope
• Standardize
• SteYX
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
481
A
MicroStrategy and Database Support for Functions
Oracle 11g
Function type
Basic functions
Date and time functions
Internal functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• First
• Geomean
• Greatest
• Last
• Least
• Max
• Median
• Min
• Multiply
• Product
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
482
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type
Null and Zero functions
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Functions that can be evaluated on the database
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
• FirstInRange
• Lag
• LastInRange
• Lead
• MovingAvg
• MovingCount
• MovingMax
• MovingMin
• MovingStdev
• MovingStdevP
• MovingSum
• OLAPAvg
• OLAPCount
• OLAPMax
• OLAPMin
• OLAPRank
• OLAPSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningStdev
• RunningStdevP
• RunningSum
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• -
• x
• +
• /
• U-
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
483
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions
Financial functions
None
None
484
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Mathematical functions
Statistical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Round
• Round2
• Sin
• Sinh
• Sqrt
• Tan
• Tanh
• Trunc
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Cosh
• Degrees
• Exp
• Floor
• Int
• Int2
• Correlation
• Covariance
• Fisher
• Intercept
• InverseFisher
• Kurtosis
• Pearson
• RSquare
• Skew
• Slope
• Standardize
• SteYX
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
485
A
MicroStrategy and Database Support for Functions
Oracle 11g R2
Function type
Basic functions
Date and time functions
Internal functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• First
• Geomean
• Greatest
• Last
• Least
• Max
• Median
• Min
• Multiply
• Product
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
486
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type
Null and Zero functions
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Functions that can be evaluated on the database
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
• FirstInRange
• Lag
• LastInRange
• Lead
• MovingAvg
• MovingCount
• MovingMax
• MovingMin
• MovingStdev
• MovingStdevP
• MovingSum
• OLAPAvg
• OLAPCount
• OLAPMax
• OLAPMin
• OLAPRank
• OLAPSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningStdev
• RunningStdevP
• RunningSum
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• -
• x
• +
• /
• U-
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
487
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions
Financial functions
None
None
488
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Mathematical functions
Statistical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Round
• Round2
• Sin
• Sinh
• Sqrt
• Tan
• Tanh
• Trunc
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Cosh
• Degrees
• Exp
• Floor
• Int
• Int2
• Correlation
• Covariance
• Fisher
• Intercept
• InverseFisher
• Kurtosis
• Pearson
• RSquare
• Skew
• Slope
• Standardize
• SteYX
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
489
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
ParAccel
The tables listed below describe the MicroStrategy function support for
ParAccel databases:
•
•
ParAccel 3.1.x
Function type
Basic functions
Date and time functions
Internal functions
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Max
• Min
• Multiply
• Product
• Sum
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
490
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type
Null and Zero functions
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Functions that can be evaluated on the database
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
• FirstInRange
• Lag
• LastInRange
• Lead
• MovingAvg
• MovingCount
• MovingMax
• MovingMin
• MovingSum
• OLAPAvg
• OLAPCount
• OLAPMax
• OLAPMin
• OLAPRank
• OLAPSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningSum
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• -
• x
• +
• /
• U-
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
491
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions
Financial functions
None
None
492
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Mathematical functions
Statistical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Cosh
• Degrees
• Exp
• Floor
• Int
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Randbetween
• Round
• Round2
• Sin
• Sinh
• Sqrt
• Tan
• Tanh
• Trunc
• Covariance
• Fisher
• Intercept
• InverseFisher
• Kurtosis
• RSquare
• Slope
• Standardize
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
493
A
MicroStrategy and Database Support for Functions
ParAccel 3.5.x
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Max
• Min
• Multiply
• Product
• Sum
• Stdev
• StdevP
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
494
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Functions that can be evaluated on the database
• FirstInRange
• Lag
• LastInRange
• Lead
• MovingAvg
• MovingCount
• MovingMax
• MovingMin
• MovingSum
• OLAPAvg
• OLAPCount
• OLAPMax
• OLAPMin
• OLAPRank
• OLAPSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningSum
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• -
• x
• +
• /
• U-
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
495
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions
Financial functions
None
None
496
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Mathematical functions
Statistical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Cosh
• Degrees
• Exp
• Floor
• Int
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Randbetween
• Round
• Round2
• Sin
• Sinh
• Tan
• Tanh
• Trunc
• Covariance
• Fisher
• Intercept
• InverseFisher
• Kurtosis
• RSquare
• Slope
• Standardize
PostgreSQL
The tables listed below describe the MicroStrategy function support for
PostgreSQL databases:
•
•
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
497
A
MicroStrategy and Database Support for Functions
PostgreSQL 8.4
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Greatest
• Least
• Max
• Min
• Multiply
• Product
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
498
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type Functions that can be evaluated on the database
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
• FirstInRange
• LastInRange
• OLAPRank
None
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• Upper
• -
• x
• +
• /
• U-
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
499
A
MicroStrategy and Database Support for Functions
Function type
Logical operators
Data mining functions
Financial functions
Mathematical functions
Statistical functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• AND
• IF
• Not
• Or
None
None
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Degrees
• Exp
• Floor
• Int
• Int2
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Randbetween
• Round
• Round2
• Sin
• Sqrt
• Tan
• Trunc
• Correlation
• Covariance
• Intercept
• RSquare
• Slope
500
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
PostgreSQL 9.x
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Greatest
• Least
• Max
• Min
• Multiply
• Product
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
501
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
• FirstInRange
• LastInRange
• OLAPRank
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• Upper
• -
• x
• +
• /
• U-
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
502
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Logical operators
Data mining functions
Financial functions
Mathematical functions
Statistical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• AND
• IF
• Not
• Or
None
None
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Degrees
• Exp
• Floor
• Int
• Int2
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Randbetween
• Round
• Round2
• Sin
• Sqrt
• Tan
• Trunc
• Correlation
• Covariance
• Intercept
• RSquare
• Slope
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
503
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Red Brick
The tables listed below describe the MicroStrategy function support for Red
Brick databases:
•
Red Brick 6.3
Function type
Basic functions
Date and time functions
Internal functions
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Max
• Min
• Multiply
• Sum
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
504
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type
Null and Zero functions
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Functions that can be evaluated on the database
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
• Lag
• Lead
• MovingAvg
• MovingCount
• MovingMax
• MovingMin
• MovingSum
• OLAPAvg
• OLAPCount
• OLAPMax
• OLAPMin
• OLAPRank
• OLAPSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningSum
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• -
• x
• +
• /
• U-
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
505
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
Comparison operators
Data mining functions
Financial functions
Mathematical functions
• <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
None
None
Statistical functions
• Abs
• Ceiling
• Exp
• Floor
• Int
• Int2
• Ln
• Mod
• Quotient
• Round
• Round2
• Sqrt
None
506
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Salesforce.com
The tables listed below describe the MicroStrategy function support for
Salesforce.com data sources:
•
Salesforce.com
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
OLAP functions
Rank and NTile functions
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Max
• Min
• Multiply
• Sum
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthsBetween
• Quarter
• Second
• Week
• Year
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
None
None
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
507
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
String functions
Arithmetic operators
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• Upper
• -
• x
• +
• /
• U-
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators
Data mining functions
• AND
• IF
• Not
• Or
None
508
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Financial functions
Mathematical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
None
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atanh
• Atan2
• Ceiling
• Cos
• Cosh
• Degrees
• Exp
• Floor
• Int
• Int2
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Randbetween
• Round
• Round2
• Sin
• Sinh
• Sqrt
• Tan
• Tanh
• Standardize Statistical functions
SAND CDBMS
The tables listed below describe the MicroStrategy function support for
SAND CDBMS databases:
•
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
509
A
MicroStrategy and Database Support for Functions
SAND CDBMS 6.1
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
OLAP functions
Rank and NTile functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Max
• Median
• Min
• Multiply
• Product
• Stdev
• Sum
• Var
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
None
• Rank
510
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type Functions that can be evaluated on the database
String functions
Arithmetic operators
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• Upper
• -
• x
• +
• /
• U-
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators
Data mining functions
• AND
• IF
• Not
• Or
None
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
511
A
MicroStrategy and Database Support for Functions
Function type
Financial functions
Mathematical functions
Statistical functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
None
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atanh
• Ceiling
• Cos
• Cosh
• Degrees
• Exp
• Floor
• Int
• Ln
• Log10
• Power
• Radians
• Round
• Round2
• Sin
• Sinh
• Sqrt
• Tan
• Tanh
• Correlation
• Covariance
• Intercept
Sybase
The tables listed below describe the MicroStrategy function support for
Sybase databases:
•
•
•
•
•
512
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Sybase ASE 15.x
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
OLAP functions
Rank and NTile functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Max
• Min
• Multiply
• Sum
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
None
None
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
513
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
String functions
Arithmetic operators
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• -
• x
• +
• /
• U-
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators
Data mining functions
Financial functions
• AND
• IF
• Not
• Or
None
None
514
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Mathematical functions
Statistical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Abs
• Acos
• Asin
• Atan
• Atan2
• Ceiling
• Cos
• Degrees
• Exp
• Floor
• Int
• Int2
• Ln
• Log10
• Mod
• Power
• Quotient
• Radians
• Round
• Round2
• Sin
• Sqrt
• Tan
None
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
515
A
MicroStrategy and Database Support for Functions
Sybase IQ 15.1
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Max
• Median
• Min
• Multiply
• Stdev
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
516
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Functions that can be evaluated on the database
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• -
• x
• +
• /
• U-
• FirstInRange
• Lag
• LastInRange
• Lead
• MovingAvg
• MovingCount
• MovingMax
• MovingMin
• MovingStdev
• MovingSum
• OLAPAvg
• OLAPCount
• OLAPMax
• OLAPMin
• OLAPRank
• OLAPSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningStdev
• RunningSum
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
517
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions
Financial functions
None
None
518
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Mathematical functions
Statistical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Abs
• Acos
• Asin
• Atan
• Atan2
• Ceiling
• Cos
• Degrees
• Exp
• Floor
• Int
• Int2
• Ln
• Log10
• Mod
• Power
• Quotient
• Radians
• Round
• Round2
• Sin
• Sqrt
• Tan
• Trunc
• Correlation
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
519
A
MicroStrategy and Database Support for Functions
Sybase IQ 15.2
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Max
• Median
• Min
• Multiply
• Stdev
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
520
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Functions that can be evaluated on the database
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• -
• x
• +
• /
• U-
• FirstInRange
• Lag
• LastInRange
• Lead
• MovingAvg
• MovingCount
• MovingMax
• MovingMin
• MovingStdev
• MovingSum
• OLAPAvg
• OLAPCount
• OLAPMax
• OLAPMin
• OLAPRank
• OLAPSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningStdev
• RunningSum
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
521
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions
Financial functions
None
None
522
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Mathematical functions
Statistical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Abs
• Acos
• Asin
• Atan
• Atan2
• Ceiling
• Cos
• Degrees
• Exp
• Floor
• Int
• Int2
• Ln
• Log10
• Mod
• Power
• Quotient
• Radians
• Round
• Round2
• Sin
• Sqrt
• Tan
• Trunc
• Correlation
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
523
A
MicroStrategy and Database Support for Functions
Sybase IQ 15.3
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Max
• Median
• Min
• Multiply
• Stdev
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
524
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Functions that can be evaluated on the database
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• -
• x
• +
• /
• U-
• FirstInRange
• Lag
• LastInRange
• Lead
• MovingAvg
• MovingCount
• MovingMax
• MovingMin
• MovingStdev
• MovingSum
• OLAPAvg
• OLAPCount
• OLAPMax
• OLAPMin
• OLAPRank
• OLAPSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningStdev
• RunningSum
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
525
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions
Financial functions
None
None
526
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Mathematical functions
Statistical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Abs
• Acos
• Asin
• Atan
• Atan2
• Ceiling
• Cos
• Degrees
• Exp
• Floor
• Int
• Int2
• Ln
• Log10
• Mod
• Power
• Quotient
• Radians
• Round
• Round2
• Sin
• Sqrt
• Tan
• Trunc
• Correlation
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
527
A
MicroStrategy and Database Support for Functions
Sybase IQ 15.4
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Max
• Median
• Min
• Multiply
• Stdev
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
528
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Functions that can be evaluated on the database
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• -
• x
• +
• /
• U-
• FirstInRange
• Lag
• LastInRange
• Lead
• MovingAvg
• MovingCount
• MovingMax
• MovingMin
• MovingStdev
• MovingSum
• OLAPAvg
• OLAPCount
• OLAPMax
• OLAPMin
• OLAPRank
• OLAPSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningStdev
• RunningSum
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
529
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions
Financial functions
None
None
530
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Mathematical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Abs
• Acos
• Asin
• Atan
• Atan2
• Ceiling
• Cos
• Degrees
• Exp
• Floor
• Int
• Int2
• Ln
• Log10
• Mod
• Power
• Quotient
• Radians
• Round
• Round2
• Sin
• Sqrt
• Tan
• Trunc
• Correlation Statistical functions
Teradata
The tables listed below describe the MicroStrategy function support for
Teradata databases:
•
•
•
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
531
A
MicroStrategy and Database Support for Functions
Teradata 12
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Max
• Min
• Multiply
• Product
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
532
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Functions that can be evaluated on the database
• Lag
• Lead
• MovingAvg
• MovingCount
• MovingMax
• MovingMin
• MovingStdev
• MovingSum
• OLAPAvg
• OLAPCount
• OLAPMax
• OLAPMin
• OLAPRank
• OLAPSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningStdev
• RunningStdevP
• RunningSum
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• -
• x
• +
• /
• U-
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
533
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions
Financial functions
None
None
534
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Mathematical functions
Statistical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Round
• Sin
• Sinh
• Sqrt
• Tan
• Tanh
• Trunc
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Cosh
• Degrees
• Exp
• Floor
• Int
• Int2
• Correlation
• Covariance
• Fisher
• Intercept
• InverseFisher
• Kurtosis
• Pearson
• RSquare
• Skew
• Slope
• Standardize
• SteYX
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
535
A
MicroStrategy and Database Support for Functions
Teradata 13
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Max
• Min
• Multiply
• Product
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
536
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Functions that can be evaluated on the database
• Lag
• Lead
• MovingAvg
• MovingCount
• MovingMax
• MovingMin
• MovingStdev
• MovingSum
• OLAPAvg
• OLAPCount
• OLAPMax
• OLAPMin
• OLAPRank
• OLAPSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningStdev
• RunningStdevP
• RunningSum
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• -
• x
• +
• /
• U-
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
537
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions
Financial functions
None
None
538
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Mathematical functions
Statistical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Round
• Sin
• Sinh
• Sqrt
• Tan
• Tanh
• Trunc
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Cosh
• Degrees
• Exp
• Floor
• Int
• Int2
• Correlation
• Covariance
• Fisher
• Intercept
• InverseFisher
• Kurtosis
• Pearson
• RSquare
• Skew
• Slope
• Standardize
• SteYX
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
539
A
MicroStrategy and Database Support for Functions
Teradata 13.10
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Max
• Min
• Multiply
• Product
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
540
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Functions that can be evaluated on the database
• Lag
• Lead
• MovingAvg
• MovingCount
• MovingMax
• MovingMin
• MovingStdev
• MovingSum
• OLAPAvg
• OLAPCount
• OLAPMax
• OLAPMin
• OLAPRank
• OLAPSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningStdev
• RunningStdevP
• RunningSum
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• -
• x
• +
• /
• U-
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
541
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions
Financial functions
None
None
542
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Mathematical functions
Statistical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Round
• Sin
• Sinh
• Sqrt
• Tan
• Tanh
• Trunc
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Cosh
• Degrees
• Exp
• Floor
• Int
• Int2
• Correlation
• Covariance
• Fisher
• Intercept
• InverseFisher
• Kurtosis
• Pearson
• RSquare
• Skew
• Slope
• Standardize
• SteYX
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
543
A
MicroStrategy and Database Support for Functions
Teradata 14
Function type
Basic functions
Date and time functions
Internal functions
Null and Zero functions
MicroStrategy Functions Reference
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Greatest
• Least
• Max
• Min
• Multiply
• Product
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Week
• Year
• YearEndDate
• YearStartDate
• Banding
• BandingC
• Coalesce
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
544
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Functions that can be evaluated on the database
• Lag
• Lead
• MovingAvg
• MovingCount
• MovingMax
• MovingMin
• MovingStdev
• MovingSum
• OLAPAvg
• OLAPCount
• OLAPMax
• OLAPMin
• OLAPRank
• OLAPSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningStdev
• RunningStdevP
• RunningSum
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• -
• x
• +
• /
• U-
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
545
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions
Financial functions
None
None
546
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Mathematical functions
Statistical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Round
• Round2
• Sin
• Sinh
• Sqrt
• Tan
• Tanh
• Trunc
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Cosh
• Degrees
• Exp
• Floor
• Int
• Int2
• Correlation
• Covariance
• Fisher
• Intercept
• InverseFisher
• Kurtosis
• Pearson
• RSquare
• Skew
• Slope
• Standardize
• SteYX
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
547
A
MicroStrategy and Database Support for Functions
Vertica
MicroStrategy Functions Reference
The tables listed below describe the MicroStrategy function support for
Vertica databases:
•
Vertica 5.1
Function type
Basic functions
Date and time functions
Internal functions
Functions that can be evaluated on the database
• Add
• Average
• Avg
• Count
• Geomean
• Max
• Min
• Multiply
• Product
• Stdev
• StdevP
• Sum
• Var
• VarP
• AddDays
• AddMonths
• CurrentDate
• CurrentDateTime
• CurrentTime
• Date
• DayOfMonth
• DayOfWeek
• DayOfYear
• DaysBetween
• Hour
• MilliSecond
• Minute
• Month
• MonthEndDate
• MonthsBetween
• MonthStartDate
• Quarter
• Second
• Year
• YearEndDate
• YearStartDate
• Coalesce
548
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference MicroStrategy and Database Support for Functions A
Function type
Null and Zero functions
OLAP functions
Rank and NTile functions
String functions
Arithmetic operators
Functions that can be evaluated on the database
• IsNotNull
• IsNull
• NullToZero
• ZeroToNull
• FirstInRange
• Lag
• LastInRange
• Lead
• MovingAvg
• MovingCount
• MovingMax
• MovingMin
• MovingStdev
• MovingSum
• OLAPAvg
• OLAPCount
• OLAPMax
• OLAPMin
• OLAPRank
• OLAPSum
• RunningAvg
• RunningCount
• RunningMax
• RunningMin
• RunningStdev
• RunningStdevP
• RunningSum
• Rank
• Concat
• ConcatBlank
• InitCap
• LeftStr
• Length
• Lower
• LTrim
• Position
• RightStr
• RTrim
• SubStr
• Trim
• Upper
• -
• x
• +
• /
• U-
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
549
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
Function type Functions that can be evaluated on the database
Comparison operators • <
• <=
• <>
• =
• >
• >=
• Begins With
• Between
• Contains
• Ends With
• In
• Like
• Not Begins With
• Not Between
• Not Contains
• Not Ends With
• Not In
• Not Like
Comparison operators for rank • *<=
• *<>
• *=
• *>=
• *Between
• Not*Between
Logical operators • AND
• IF
• Not
• Or
Data mining functions
Financial functions
None
None
550
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
MicroStrategy Functions Reference
Function type
Mathematical functions
Statistical functions
MicroStrategy and Database Support for Functions A
Functions that can be evaluated on the database
• Abs
• Acos
• Acosh
• Asin
• Asinh
• Atan
• Atan2
• Atanh
• Ceiling
• Cos
• Degrees
• Exp
• Ln
• Log
• Log10
• Mod
• Power
• Quotient
• Radians
• Randbetween
• Round
• Round2
• Sin
• Sqrt
• Tan
• Trunc
• Standardize
© 2012 MicroStrategy, Inc.
Databases that a function can be evaluated on
551
A
MicroStrategy and Database Support for Functions MicroStrategy Functions Reference
552
Databases that a function can be evaluated on © 2012 MicroStrategy, Inc.
G
LOSSARY
Analytical Engine
A component of the MicroStrategy Intelligence Server that performs all advanced analytical functions. The Analytical
Engine evaluates functions not supported by the data warehouse RDBMS and it cross-tabulates reports.
application object
MicroStrategy object used to provide analysis of and insight into relevant data. Application objects are developed in
MicroStrategy Desktop and they are the building blocks for reports and documents. Application objects include (among others) these object types: report, document, template, filter, metric, custom group, consolidation, prompt.
attribute
A data level defined by the system architect and associated with one or more columns in a data warehouse lookup table.
Attributes include data classifications like Region, Order,
Customer, Age, Item, City, and Year. They provide a means for aggregating and filtering at a given level.
See also:
• attribute element
• attribute form attribute element
A value of any of the attribute forms of an attribute. For example, New York and Dallas are elements of the attribute
City; January, February, and March are elements of the attribute Month.
© 2012 MicroStrategy, Inc.
Glossary: Analytical Engine
553
Glossary MicroStrategy Functions Reference
attribute form
One of several columns associated with an attribute that are different aspects of the same thing. ID, Name, Last