Technical Reference Index

Symbols

! report command
& calc command
& report command
< (left angle bracket) in reports
{} (curly braces) in reports
$ (dollar sign) in MaxL Command Shell variables

"" ' '(quotation marks)

and ESSCMD commands

in the MaxL Command Shell

; (semicolon)

and ESSCMD commands

in the MaxL Command Shell

A

ABS function
absolute value
accounts tag
ACCUM function
ADDUSER ESSCMD command
AFTER report command
AGENTDELAY config setting
AGENTLOGMESSAGELEVEL config setting
AGENTTHREADS config setting
AGG calc command

aggregating

only parents with same currency

aliases

alter in MaxL

user

ancestor-level data return

based on shared ancestor value of current member from multiple dimensions

ancestor functions

selecting all ancestors of a member excluding the member

selecting one ancestor of a member excluding the member

selecting a member and all of its ancestors

selecting a member and a range of its ancestors

selecting a range of the member's ancestors excluding the member
ANCESTORS function
ANCEST function

ancestors in reports

adding a member and its ancestors adding a member's ancestors only
ANCESTORS report command
ANCESTVAL function
application log error message controls
applications, sample files used in this document
APPLYOTLCHANGEFILE ESSCMD command
ARCHIVE ESSCMD command
archiving with log files
ARRAY calc command

arrays, declaring variables
ASYM report command
attDimName
attMbrName
ATTRIBUTE report command
ATTRIBUTE function
attribute information for a member
attribute specifications, informational ESSCMD
ATTRIBUTEVAL function
ATTRIBUTEBVAL function
ATTRIBUTESVAL function
audience for Technical Reference

average

of all values of expList of specified member across a range
AVG function
AVGRANGE function

B

command errors in ESSCMD, handling

batch mode

command line syntax for

creating scripts for

error handling

examples
batch processing in ESSCMD
BEFORE report command
BEGINARCHIVE ESSCMD command
BEGININCBUILDDIM ESSCMD command
BLOCKHEADERS report command

limiting number of locks

limiting the time a lock is held

locking to calculate
Boolean functions
BOTTOM report command
BRACKETS report command
building dimensions
buffer size for network communication
BUILDDIM ESSCMD command

Cache Memory Locking

information

enabling/disabling (ESSCMD)

enabling/disabling (MaxL "cache pinning")
CALC ALL calc command
CALC AVERAGE calc command
CALC DIM calc command
CALC ESSCMD command
CALC FIRST calc command
CALC LAST calc command
CALC TWOPASS calc command
CALCCACHE TRUE | FALSE config setting
CALCCACHEHIGH | DEFAULT | LOW config setting
CALCDEFAULT ESSCMD command
CALCHASHTBLMEMORY config setting
CALCLINE ESSCMD command
CALCLOCKBLOCK config setting
CALCMODE function
CALCNOTICE config setting
CALCOPTCALCHASHTBL config setting
CALCOPTFRMLBOTTOMUP config setting
CALCULATE COLUMN report command
CALCULATE ROW report command

calculating

control flow commands

currency conversions

data declaration commands

formulas and aggregations

Intelligent Calculation

interdependent formulas

last members

locking blocks concurrently

mathematical functions

mathematical operators

optimizing formulas on sparse dimensions

optimizing large, flat database outlines

parents with same defined currency

range functions

relationship functions

restricting

rows and columns

SET commands

specifying clean data blocks

specifying how many iterations

subsets of the database

temporary variables

tracing

Two-Pass members

types of calculations

using MaxL

calculations

setting the default (MaxL)

calculation commands

data declaration commands

control flow commands

computation commands

member formulas

calculation operators

overview
calculation operators

calculator caches

default size

setting the size

whether Essbase uses
canceling operations in ESSCMD
CASESENSITIVE config setting
case-sensitivity of member names
cash flow, internal rate of return
CCONV calc command
CCTRACK config setting
cells, replicated See partitioning
.CFG client file
.CFG server file
characters, underlining in a report

.CHG (outline change) file

creating

applying

purging after changes have been applied

resetting time stamp
CHILDREN function
CHILDREN report command
clean status
CLEARALLROWCALC report command
CLEARBLOCK calc command
CLEARDATA calc command

clearing

blocks

data
CLEARLOGFILE config setting
CLEARROWCALC report command
client ESSBASE.CFG file, creating
COLHEADING report command
column or row calculation commands

columns

calculating

displaying dimensions as

underlining in a report
COLUMN report command

commands

report
COMMAS report command
COMMITBLOCKS config setting
completion notices for calculations
COMPOUND function
compounded growth calculation
compounded interest calculation
COMPOUNDGROWTH function
CONCATENATE function
concurrent calculations
conditional and logical operators
conditional tests
control flow commands
COPYAPP ESSCMD command
COPYDB ESSCMD command
COPYFILTER ESSCMD command
COPYOBJECT ESSCMD command
CORRELATION function
COUNT function

create in MaxL

user
CREATEAPP ESSCMD command
CREATEDB ESSCMD command
CREATEGROUP ESSCMD command
CREATELOCATION ESSCMD command
CREATEUSER ESSCMD command

CREATEVARIABLE ESSCMD command

MaxL equivalent (system-wide variable)

MaxL equivalent (application-wide variable)

MaxL equivalent (database-wide variable)
cross-dimensional operator (->)
CURGEN function
CURHEADING report command
CURLEV function

currency conversions

calculating

displaying headings of

modifying behavior of

performing in a report

suppressing currency information in a report

tracking system
currency databases, informational commands

CURRENCY report command
CURRMBR function
CURRMBRRANGE function
custom-defined functions
custom-defined macros
customizing Essbase configuration

data

exporting and reporting(MaxL)

importing (MaxL)

loading, clearing, and exporting (ESSCMD)

ordering

restricting ranges
DATACOMPRESS config setting
DATACOMPRESSIONTYPE config Setting
DATACOPY calc command
data declaration commands
data ordering commands
data range commands

databases

aggregating

aggregating parent/child relationships

altering (MaxL)

calculating

calculating (MaxL)

clearing sections of data from

loading, clearing, and exporting data (ESSCMD)

loading (MaxL)

managing (ESSCMD)

managing (MaxL)

restructuring incrementally
DATACOMPRESS config setting
DATACOMPRESSIONTYPE config setting
DATACOPY calc command
DATAERRORLIMIT config setting
.DDB (partition definition) file
DECIMAL report command
DECLINE function
defaults, function parameters
DEFRAG ESSCMD command
DELETEAPP ESSCMD command
DELETEDB ESSCMD command
DELETEGROUP ESSCMD command
DELETELOCATION ESSCMD command
DELETELOG ESSCMD command
DELETEUSER ESSCMD command
DELETEVARIABLE ESSCMD command
deleting in MaxL: See drop in MaxL

depreciation calculation methods

declining balance

straight line

sum of year's digits
DESCENDANTS function
DESCENDANTS report command
DIMBOTTOM report command
DIMEND report command

dimensions

row
DIMTOP report command
dirty status
DISABLELOGIN ESSCMD command
DISCOUNT function
DISKVOLUMES config setting

display in MaxL

variable
DISPLAYALIAS ESSCMD command
document conventions for Technical Reference

drop in MaxL

application

calculation

database

disk volume: See alter database

variable: see alter database, alter application, alter system
DUPLICATE report command
DYNCALCCACHECOMPRBLKBUFSIZE config setting
DYNCALCCACHEBLKRELEASE config setting
DYNCALCCACHEBLKTIMEOUT config setting
DYNCALCCACHEMAXSIZE config setting
DYNCALCCACHEONLY config setting
DYNCALCCACHEWAITFORBLK config setting

E

echo in MaxL ELSE command
ELSE macro function
ELSEIF command
ENABLELOGIN ESSCMD command
ENDARCHIVE ESSCMD command
ENDHEADING report command
ENDINCBUILDDIM ESSCMD command
ENDIF command
ENDIF macro function
entering commands in ESSCMD
equations in calc scripts

error handling and logging

determining how many records can be written during a data load

determining where data is written

in ESSCMD

in MaxL

spreadsheet error messages

with unknown member names
ERROR macro function

ESSBASE.CFG

file

settings
Essbase functions
Essbase Perl Module (Essbase.pm) Essbase settings

ESSCMD

batch files

batch files, writing

command errors, handling

batch processing

canceling operations

entering commands

importing and calculating data (sample)

interactive mode

logging into the server

multi-user considerations

operating system platforms

overview

quitting

referencing files

scheduling report printing (sample)

script files

running

samples

writing

command errors, handling

SQL script, updating (sample)

starting

syntax guidelines

quotation marks

semicolon statement terminator

updating a SQL script (sample) essmsh
EUROPEAN report command
EXCEPTIONLOGOVERWRITE config setting
EXCLUSIVECALC config setting
execute calculation in MaxL
EXIT ESSCMD command
expList
EXP function
export in MaxL
EXPORT ESSCMD command
EXPORTTHREADS config setting
expression

F

FACTORIAL function
FEEDON report command
filters
financial functions
first, calculating members tagged as
FIX..ENDFIX calc command
FIXCOLUMNS report command
forecasting functions
format commands
FORMATCOLUMNS report command
formatting conventions formulas for members in calc scripts

conditional

interdependent

function parameters

functions

custom-defined

G

generations

and levels, described

selecting all members with a shared generation

determining generation of a member

determining generation of a member in relation to the top member

determining whether a member is of a certain generation

determining whether members are of the same generation
GEN function
genLevName
genLevNum
GENMBRS function
GETALLREPLCELLS ESSCMD command
GETAPPACTIVE ESSCMD command
GETAPPINFO ESSCMD command
GETAPPSTATE ESSCMD command
GETATTRIBUTESPECS ESSCMD command
GETATTRINFO ESSCMD command
GETCRDB ESSCMD command
GETCRDBINFO ESSCMD command
GETCRRATE ESSCMD command
GETCRTYPE ESSCMD command
GETDBACTIVE ESSCMD command
GETDBINFO ESSCMD command
GETDBSTATE ESSCMD command
GETDBSTATS ESSCMD command
GETDEFAULTCALC ESSCMD command
GETMBRCALC ESSCMD command
GETMBRINFO ESSCMD command
GETMEMBERS ESSCMD command
GETPARTITIONOTLCHANGES ESSCMD command
GETPERFSTATS ESSCMD command
GETUPDATEDREPLCELLS ESSCMD command
GETUSERINFO ESSCMD command
GETVERSION ESSCMD command
GOTO ESSCMD command
grant in MaxL
GROWTH function

H

HEADING report command
headings of pages
Help
HELP ESSCMD command

I

IALLANCESTORS function
IANCESTORS function
IANCESTORS report command
ICHILDREN function
ICHILDREN report command
IDESCENDANTS function
IDESCENDANTS report command
IF command
IFERROR ESSCMD command
IFSTRCMP macro function
ILSIBLINGS function
IMMHEADING report command
IMPORT ESSCMD command
import in MaxL
importing and calculating data in ESSCMD (sample)
INCBUILDDIM ESSCMD command
INCEMPTYROWS report command
INCFORMATS report command
INCMASK report command
INCMISSINGROWS report command
incremental restructuring
INCRESTRUC config setting
INCZEROROWS report command
INDENT report command
INDENTGEN report command
INDEXCACHESIZE config setting
INDEXPAGESIZE config setting
INT function
integer values

intelligent calculation

specifying default setting

turning on or off
interactive mode in ESSCMD
interdependent formulas
INTEREST function
internal rates of return
IPARENT report command
IRR function
IRDESCENDANTS function
IRSIBLINGS function
ISACCTYPE function
ISANCEST function
ISCHILD function
ISDESC function
ISGEN function
ISIANCEST function
ISIBLINGS function
ISICHILD function
ISIDESC function
ISIPARENT function
ISISIBLING function
ISLEV function
ISMBR function
ISPARENT function
ISSAMEGEN function
ISSAMELEV function
ISSIBLING function
ISUDA function

J

JVMMODULELOCATION config setting

K-L

keywords in MaxL
last, calculating members tagged as
LATEST report command

levels

and generations described

determining level of a member

determining level of a member in relation to the bottom-most descendant

determining whether a member is of a certain level

determining whether members are of the same level

locks

limiting number of blocks

limiting time users can hold

viewing and removing
LOCKTIMEOUT config setting

log files

determining overwrite

timing queries and reports
LOG function
LOG10 function
logical and conditional operators
logging into the server in ESSCMD
LOGIN ESSCMD command
login in MaxL
LOGMESSAGELEVEL config setting
LOGOUT ESSCMD command
logout in MaxL
LOGOUTALLUSERS ESSCMD command
LOGOUTUSER ESSCMD command
LOOP..ENDLOOP calc command
LSIBLINGS function
Lx macro function

M

macro functions. See member set functions
macros, custom-defined
MASK report command
MATCH function
MATCH report command
mathematical functions
mathematical operators
MAX function
maximum value of expressions in member list

MaxL

variables
MAXRANGE function
MAXS function
MAXSRANGE function
mbrList
mbrName
MDALLOCATE function
MDANCESTVAL function
MDPARENTVAL function
MDSHIFT function
MEDIAN function
member set functions

members

case-sensitivity of names

descendants

determining location of

formulas in calc scripts

mbrName

names and aliases

selecting and sorting in Report Writer
MERGE function
migration to Release 6.1
MIN function
minimum value of expressions
MINRANGE function
MINS function
MINSRANGE function
MISSINGTEXT report command

missing values (#)

aggregating

clearing blocks

clearing data

displaying empty rows

displaying missing rows

resetting name of a calc row to #MISSING

substituting with a text label
MOD function
MODE function
MOVAVG function
MOVMAX function
MOVMED function
MOVMIN function

multiple dimensions

ancestor-level data

parent-level data return

shifting data values across
multi-user considerations in ESSCMD

N

n, integer value
names in MaxL
NAMESCOL report command
NAMESON report command
NAMEWIDTH report command
nested IF statements
NETDELAY config setting
NETDELAY config setting
NETNPCONNECTTIMEOUT config setting
net present value
NETRETRYCOUNT config setting
NETRETRYCOUNT config setting

network

delay time
retry connections
Named Pipes

NEWPAGE report command
NEXT function
NODENAME config setting
NOINDENTGEN report command
NOPAGEONDIMENSION report command
NOROWREPEAT report command
NOSKIPONDIMENSION report command
notices for calculation progress
NOUNAMEONDIM report command
NPV function
numbers in MaxL
numerical precision used in comparing digits
NUMERICPRECISION config setting

O

objects, database
OFFCOLCALCS report command
OFFROWCALCS report command
OFSAMEGEN report command
ONCOLCALCS report command
ONROWCALCS report command
ONSAMELEVELAS report command
operating system platforms in ESSCMD

operators

conditional and logical

cross-dimensional (->)

mathematical
ORDER report command
ORDERBY report command
OUTALT report command
OUTALTMBR report command
OUTALTNAMES report command
OUTALTSELECT report command
OUTLINECHANGELOG config setting
OUTLINECHANGELOGFILESIZE config setting
outline changes
outline information, viewing
outline synchronization
OUTMBRALT report command
OUTMBRNAMES report command

output

generating in a report

zero values as text

resuming in a report

suppressing in a report

in MaxL

writing reports with MaxL

OUTPUT ESSCMD command
OUTPUT report command

P

page breaks

inserting

enabling when maximum number of lines is exceeded

suppressing when maximum number of lines is exceeded

page headings

defining in place of current

displaying

displaying before next row

displaying immediately

ending definition of

suppressing

suppressing with other formatting

pages

setting maximum number of lines per page
PAGE report command
PAGEHEADING report command
PAGELENGTH report command
PAGEONDIMENSION report command

parallel export

ESSCMD

MaxL
parameters in functions

parent-level data return

based on shared parent value of current member

from multiple dimensions
PARENT function
PARENT report command

parents

adding to report

returning values of
PARENTVAL function
partial calculations

partitioning (ESSCMD)

partition definition (.DDB) file

getting all replicated cells from the source (target is current)

putting all replicated cells into the target (source is current)

getting updated replicated cells from the source (target is current)

putting updated replicated cells into the target (source is current)

partitioning (MaxL)

create partition

display partition

drop partition

refresh replicated partition
PAREXPORT ESSCMD command

performance statistics

getting

resetting
period-to-date values
PIPEBUFFERSIZE config setting
POWER function
precision digits, how many used for numerical comparison
PRINTPARTITIONDEFFILE ESSCMD command
PRINTROW report command
PRIOR function

privileges in MaxL

described

granting
PTD function
PURGELINKEDOBJECTS ESSCMD command command
PURGEOTLCHANGEFILE ESSCMD command command
PUTALLREPLCELLS ESSCMD command command
PUTUPDATEDREPLCELLS ESSCMD command command
PYRAMIDHEADERS report command

Q

quitting ESSCMD
QUOTEMBRNAMES report command

R

RANGE function
range functions
rangeList

ranges

functions

maximum value across a range

multiple dimension

returning a member range list

standard deviation across a range

summation across a range

RANK function
referencing files in ESSCMD
refresh replicated partition in MaxL
reiterating commands
relationship functions
relationships between members
RDESCENDANTS function
RELATIVE function
REMAINDER function
remainder value
REMOVE function
REMOVECOLCALCS report command
REMOVELOCKS ESSCMD command
REMOVEUSER ESSCMD command
RENAME report command
RENAMEAPP ESSCMD command
RENAMEDB ESSCMD command
RENAMEFILTER ESSCMD command
RENAMEOBJECT ESSCMD command
RENAMEUSER ESSCMD command
repeating commands
replicated cells See partitioning
REPORT ESSCMD command
report layout commands
REPORTLINE ESSCMD command

reports

alias and member name display

column or row calculation

member selection and sorting

output

query timing

referencing static members

running

syntax

writing reports with MaxL

Report Writer

command groups

overview

syntax and abbreviations

REPTKBYTEBUF config setting
REPTKBYTESORTBUF config setting
RESETDB ESSCMD command
RESETOTLCHANGETIME ESSCMD command
RESETPERFSTATS ESSCMD command
RESETSTATUS ESSCMD command
RESTRICT report command
restructuring databases incrementally
ROUND function
ROW report command

row calculation commands

CALCULATE ROW report command

CLEARALLROWCALC report command

CLEARROWCALC report command

OFFROWCALCS report command

ONROWCALCS report command

PRINTROW report command

SAVEANDOUTPUT report command

SAVEROW report command

SETROWOP report command

row processing limit
ROWREPEAT report command
RSIBLINGS function
RUNCALC ESSCMD command
RUNREPT ESSCMD command

S

S macro function
sample applications
SANCESTVAL function
SAVEANDOUTPUT report command
SAVEROW report command
SCALE report command
scheduling report printing in ESSCMD (sample)

security privileges and roles in MaxL

described

granting

script files, ESSCMD

running

samples

writing

command errors, handling

security

SELECT ESSCMD command
semicolons, in functions
server ESSBASE.CFG file, creating
server identification
SERVERTHREADS config setting
server threads
SET AGGMISSG calc command
SET CACHE calc command
SET CALCHASHTBL calc command
SET CLEARUPDATESTATUS calc command
Set Commands
SET FRMLBOTTOMUP calc command
SET LOCKBLOCK calc command
SET MSG calc command
SET NOTICE calc command
SET UPDATECALC calc command
SET UPTOLOCAL calc command
SETALIAS ESSCMD command
SETAPPSTATE ESSCMD command
SETCENTER report command
SETDBSTATE ESSCMD command
SETDBSTATEITEM ESSCMD command
SETDEFAULTCALC ESSCMD command
SETDEFAULTCALCFILE ESSCMD command
SETHELP ESSCMD command
SETLOGIN ESSCMD command
SETMSGLEVEL ESSCMD command
SETPASSWORD ESSCMD command
SETROWOP report command
SHIFT function
shifting data values across multiple-dimension ranges
SHUTDOWNSERVER ESSCMD command
SHx macro function
SIBLINGS function
simple interest calculation
SINGLECOLUMN report command
SKIP report command
SKIPONDIMENSION report command
SLEEP ESSCMD command
SLN function

sorting commands

SORTALTNAMES report command

SORTASC report command

SORTDESC report command

SORTGEN report command

SORTLEVEL report command

SORTMBRNAMES report command

SORTNONE report command

sources of information
SPARENTVAL function
sparse dimension consolidation
SPARSE report command
SPLINE function

spreadsheet

error messages

query timing

specifying maximum number of rows processed

update logging
SQL script, updating in ESSCMD (sample)
SSAUDIT, SSAUDITR config setting
SSLOGUNKNOWN config setting
SSPROCROWLIMIT config setting
standard deviation, based on sample
standard deviation, based on population
standard deviation across a range
STARTHEADING report command
starting ESSCMD
statements in MaxL
static member definition
statistical functions

statistics for performance

resetting
status, clean or dirty
STDEV function
STDEVP function
STDEVRANGE function
strings in MaxL
SUBSTRING function
SUM function
SUMRANGE function
SUPALL report command
SUPBRACKETS report command
SUPCOLHEADING report command
SUPCOMMAS report command
SUPCURHEADING report command
SUPEMPTYROWS report command
SUPEUROPEAN report command
SUPFEED report command
SUPFORMATS report command
SUPHEADING report command
SUPMASK report command
SUPMISSINGROWS report command
SUPNAMES report command
SUPOUTPUT report command
SUPPAGEHEADING report command
SUPSHARE report command
SUPSHAREOFF report command
SUPZEROROWS report command
SYD function
SYM report command
synchronizing outlines
syntax for calculation functions
syntax for ESSCMD commands
syntax for Report Writer commands

T

TABDELIMIT report command
tabs in report output
tag

temporary variables

containing a single value

one-dimensional array

terminals in MaxL syntax

defined

listed
TEXT report command
threads on the server, how many allowed
Time dimension, period-to-date values in
TIMINGMESSAGES config setting
TODATE report command
TODATE function
tokens in MaxL
TOP report command
tracing calculations
transaction threads, how many allowed
TREND function
TRUNCATE function
two Pass calculation

U

UCHARACTERS report command
UCOLUMNS report command
UDA function
UDA report command
UDATA report command
UNAME report command
UNAMEONDIMENSION report command
UNDERLINECHAR report command

underlining in a report

changed row member names in same dimension

characters in preceding row

data columns only

default

name and data columns

name columns only

turning off for new member names in same dimension
UNDERSCORECHAR report command
UNLOADALIAS ESSCMD command
UNLOADAPP ESSCMD command
UNLOADDB ESSCMD command
UNLOCKOBJECT ESSCMD command
UPDATE ESSCMD command
UPDATECALC config setting
UPDATEFILE ESSCMD command
UPDATEVARIABLE ESSCMD command
updating a SQL script in ESSCMD (sample)
upgrading

V

VALIDATE ESSCMD command
VALIDATEPARTITIONDEFFILE ESSCMD command
VAR calc command
VAR function

variables, temporary

containing a single value

one-dimensional array

variance

between members

percentage between members

statistical, based on sample

statistical, based on population
VARIANCE function
VARIANCEP function
VARPER function

W

what you should know before you start using this document
what's new in Release 6
who should read this document
WIDTH report command
WITHATTR report command
WITHATTR function

X-Z

x macro function (@@x)
XREF function
ZEROTEXT report command
zero values, replacing in output with text