Table of Contents
- Title and Copyright Information
- 1 Scripting Reference Overview
-
2
Essbase Command-Line Interface (CLI)
- Download and Use the Command-Line Interface
-
CLI Command Reference
- Login/Logout: CLI Authentication
- Calc: Run a Calculation Script
- Clear: Remove Data from a Cube
- Createlocalconnection: Save a JDBC Connection
- Dataload: Load Data to a Cube
- Deletefile: Remove Cube Files
- Deploy: Create a Cube from a Workbook
- Dimbuild: Load Dimensions to a Cube
- Download: Get Cube Files
- Help: Display Command Syntax
- LcmExport: Back Up Cube Files
- LcmImport: Restore Cube Files
- Listapp: Display Applications
- Listdb: Display Cubes
- Listfiles: Display Files
- Listfilters: View Security Filters
- Listlocks: View Locks
- Listvariables: Display Substitution Variables
- Setpassword: Store CLI Credentials
- Start: Start an Application or Cube
- Stop: Stop an Application or Cube
- Unsetpassword: Remove Stored CLI Credentials
- Upload: Add Cube Files
- Version: Display API Version
-
3
MaxL
- Manage Essbase Using the MaxL Client
- How to Read MaxL Railroad Diagrams
-
MaxL Statements
- Listed By Verbs
-
Listed by Objects
- Aggregate Build
- Aggregate Process
- Aggregate Selection
- Allocation
- Application
- Archive_file
- Calculation
- Custom Definitions
- Data
- Database
- Dimensions
- Drillthrough
- Filter
- Function
- Group
- Location Alias
- Lock
- LRO
- Macro
- Object
- Outline
- Partition
- Privilege
- Query_tracking
- Session
- System
- Tablespace
- Trigger
- Trigger Spool
- User
- Variable
-
MaxL Statement Reference
- Alter Application
- Alter Database
- Alter Database enable | disable
- Alter Database Set
- Alter Database (Misc)
- Alter Drillthrough
- Alter Filter
- Alter Group
- Alter Object
- Alter Partition
- Alter Session
- Alter System
- Alter Trigger
- Alter User
- Create Application
- Create Calculation
- Create Database
- Create Drillthrough
- Create Filter
- Create Function
- Create Group
- Create Location Alias
- Create Macro
- Create Partition
- Create Replicated Partition
- Create Transparent Partition
- Create Trigger
- Create After-Update Trigger
- Create On-Update Trigger
- Create User
- Display Application
- Display Calculation
- Display Database
- Display Drillthrough
- Display Filter
- Display Filter Row
- Display Function
- Display Location Alias
- Display Lock
- Display Macro
- Display Object
- Display Partition
- Display Privilege
- Display Session
- Display System
- Display Trigger
- Display Trigger Spool
- Display Variable
- Drop Application
- Drop Calculation
- Drop Database
- Drop Drillthrough
- Drop Filter
- Drop Function
- Drop Group
- Drop Location Alias
- Drop Lock
- Drop Macro
- Drop Object
- Drop Partition
- Drop Trigger
- Drop Trigger Spool
- Drop User
- Execute Calculation
- Export Data
- Export LRO
- Export Outline
- Grant
- Import Data
- Import Dimensions
- Import LRO
- Query Application
- Query Archive_File
- Query Database
- Refresh Custom Definitions
- Refresh Outline
- Refresh Replicated Partition
- Performance Statistics in MaxL
-
MaxL Statements (Aggregate Storage)
- Alter Application (Aggregate Storage)
- Alter Database (Aggregate Storage)
- Alter System (Aggregate Storage)
- Alter Tablespace (Aggregate Storage)
- Create Application (Aggregate Storage)
- Create Database (Aggregate Storage)
- Create Outline (Aggregate Storage)
- Display Tablespace (Aggregate Storage)
- Execute Aggregate Build (Aggregate Storage)
- Execute Aggregate Process (Aggregate Storage)
- Execute Aggregate Selection (Aggregate Storage)
- Execute Allocation (Aggregate Storage)
- Execute Calculation (Aggregate Storage)
- Export Data (Aggregate Storage)
- Export Query Tracking (Aggregate Storage)
- Import Data (Aggregate Storage)
- Import Query Tracking (Aggregate Storage)
- Query Application (Aggregate Storage)
- Query Database (Aggregate Storage)
-
MaxL Definitions
- MaxL Syntax Notes
- Numbers in MaxL Syntax
-
Terminals
- ACTION
- ALLOC-NUMERIC
- ALT-NAME-SINGLE
- APP-NAME
- AREA-ALIAS
- BUFFER-ID
- CALC-NAME
- CALC-NAME-SINGLE
- CALC-SPEC-STRING
- CALC-STRING
- COLUMN-WIDTH
- COMMENT-STRING
- CONDITION
- CUBE-AREA or MDX-SET
- DATE
- DBS-EXPORT-DIR
- DBS-NAME
- DBS-STRING
- DIM-NAME
- EXPORT-DIR
- FILE-NAME
- FILE-NAME-PREFIX
- FILTER-NAME
- FULL-EXPORT-DIR
- FUNC-NAME
- GROUP-NAME
- HOST-NAME
- ID-RANGE
- ID-STRING
- IMP-FILE
- IMPORT-DIR
- JAVACLASS.METHOD
- LOCATION-ALIAS-NAME
- LOC-ALIAS-SINGLE
- LOG-TIME
- MACRO-EXPANSION
- MACRO-NAME
- MEMBER-EXPRESSION
- MEMBER-NAME
- OBJ-NAME
- OBJ-NAME-SINGLE
- OUTLINE-ID
- PASSWORD
- PATHNAME_FILENAME
- PRECISION-DIGITS
- PROPS
- RNUM
- RTSV-LIST
- RULE-FILE-NAME
- SESSION-ID
- SIZE-STRING
- SPOOL-NAME
- STOPPING-VAL
- TABLSP-NAME
- TRIGGER-NAME
- URL-NAME
- USER-NAME
- VARIABLE-NAME
- VIEW-FILE-NAME
- VIEW-ID
- VIEW-SIZE
- Privileges and Roles
- Quoting and Special Characters Rules for MaxL Language
- MaxL Shell Commands
- MaxL Shell and Unicode
- MaxL Shell Syntax Rules and Variables
- Query Cancellation
- Encryption
- LoginAs
- Login
- ESSCMD Script Conversion
- MaxL Reserved Words List
- MaxL BNF
- MaxL Use Cases
-
4
Report Writer
- Report Writer Syntax
- Report Writer Command Groups
-
Examples of Report Scripts
- Sample 1: Creating a Different Format for Each Page
- Sample 2: Handling Missing Values
- Sample 3: Nesting Columns
- Sample 4: Grouping Rows
- Sample 5: Reporting on Different Combinations of Data
- Sample 6: Formatting Different Combinations of Data
- Sample 7: Using Aliases
- Sample 8: Creating Custom Headings and % Characters
- Sample 9: Creating Custom Page Headings
- Sample 10: Using Formulas
- Sample 11: Placing Two-Page Layouts on the Same Page
- Sample 12: Formatting for Data Export
- Sample 13: Creating Asymmetric Columns
- Sample 14: Calculating Columns
- Sample 15: Calculating Rows
- Sample 16: Sorting by Top or Bottom Data Values
- Sample 17: Restricting Rows
- Sample 18: Ordering Data Values
- Sample 19: Narrowing Member Selection Criteria
- Sample 20: Using Attributes in Member Selection
- Sample 21: Using the WITHATTR Command in Member Selection
-
Report Writer Command List
- &
- !
- ACCOFF
- ACCON
- AFTER
- ALLINSAMEDIM
- ALLSIBLINGS
- ANCESTORS
- ASYM
- ATTRIBUTE
- ATTRIBUTEVA
- BEFORE
- BLOCKHEADERS
- BOTTOM
- BRACKETS
- CALCULATE COLUMN
- CALCULATE ROW
- CHILDREN
- CLEARALLROWCALC
- CLEARROWCALC
- COLHEADING
- COLUMN
- COMMAS
- CURHEADING
- CURRENCY
- DATEFORMAT
- DECIMAL
- DESCENDANTS
- DIMBOTTOM
- DIMEND
- DIMTOP
- DUPLICATE
- ENDHEADING
- EUROPEAN
- FEEDON
- FIXCOLUMNS
- FORMATCOLUMNS
- GEN
- HEADING
- IANCESTORS
- ICHILDREN
- IDESCENDANTS
- IMMHEADING
- INCEMPTYROWS
- INCFORMATS
- INCMASK
- INCMISSINGROWS
- INCZEROROWS
- INDENT
- INDENTGEN
- IPARENT
- LATEST
- LEAVES
- LEV
- LINK
- LMARGIN
- MASK
- MATCH
- MATCHEX
- MEANINGLESSTEXT
- MISSINGTEXT
- NAMESCOL
- NAMESON
- NAMEWIDTH
- NEWPAGE
- NOINDENTGEN
- NOPAGEONDIMENSION
- NOROWREPEAT
- NOSKIPONDIMENSION
- NOUNAMEONDIM
- OFFCOLCALCS
- OFFROWCALCS
- OFSAMEGEN
- ONCOLCALCS
- ONROWCALCS
- ONSAMELEVELAS
- ORDER
- ORDERBY
- OUTALT
- OUTALTMBR
- OUTALTNAMES
- OUTALTSELECT
- OUTFORMATTEDMISSING
- OUTFORMATTEDVALUES
- OUTMBRALT
- OUTMBRNAMES
- OUTMEANINGLESS
- OUTPUT
- OUTPUTMEMBERKEY
- PAGE
- PAGEHEADING
- PAGELENGTH
- PAGEONDIMENSION
- PARENT
- PERSPECTIVE
- PRINTROW
- PYRAMIDHEADERS
- QUOTEMBRNAMES
- REMOVECOLCALCS
- RENAME
- REPALIAS
- REPALIASMBR
- REPMBR
- REPMBRALIAS
- REPQUALMBR
- RESTRICT
- ROW
- ROWREPEAT
- SAVEANDOUTPUT
- SAVEROW
- SCALE
- SETCENTER
- SETROWOP
- SINGLECOLUMN
- SKIP
- SKIPONDIMENSION
- SORTALTNAMES
- SORTASC
- SORTDESC
- SORTGEN
- SORTLEVEL
- SORTMBRNAMES
- SORTNONE
- SPARSE
- STARTHEADING
- SUDA
- SUPALL
- SUPBRACKETS
- SUPCOLHEADING
- SUPCOMMAS
- SUPCURHEADING
- SUPEMPTYROWS
- SUPEUROPEAN
- SUPFEED
- SUPFORMATS
- SUPHEADING
- SUPMASK
- SUPMISSINGROWS
- SUPNAMES
- SUPOUTPUT
- SUPPAGEHEADING
- SUPSHARE
- SUPSHAREOFF
- SUPZEROROWS
- SYM
- TABDELIMIT
- TEXT
- TODATE
- TOP
- UCHARACTERS
- UCOLUMNS
- UDA
- UDATA
- UNAME
- UNAMEONDIMENSION
- UNDERLINECHAR
- UNDERSCORECHAR
- WIDTH
- WITHATTR
- WITHATTREX
- ZEROTEXT
- Report Writer Limits