Welcome to the online API Reference. To help you get started using this document, this introduction provides the following information:
This document is designed for engineers and programmers who need to develop custom front-end programs that access Hyperion Essbase OLAP server.
The online API Reference is a comprehensive reference to the functions and libraries you can use to develop custom front-end programs that access Essbase application servers. The document provides:
This document describes the Hyperion Essbase API. If you need information on other topics, see the following manuals.
To use this book, you need the following:
To make the online API Reference easier to use, the it uses the syntax, and text conventions described in this section.
The following text conventions are used throughout this guide:
Convention | Purpose |
1, 2, 3 | Procedures or steps that you follow in order. |
( ) | Bulleted lists provide information, not procedural steps. |
This Font | Member names and the names of other Essbase objects. |
italics | Titles of books, important terms and special emphasis. |
| | Vertical bar separator between pop-up menu items and top-level menu items (shown in the menu bar). For example, Essbase|FlashBack means the FlashBack command on the Essbase menu in the Spreadsheet Add-in |
enter | Type characters, then press the Enter key. |
To make code and examples easier to understand, this guide uses the following conventions.
Convention | Purpose | Example |
monospace font | Function, structure, file, directory, and environment variables names in text | ESS_STS_T, ESSAPIW.LIB |
italic | Anything you replace with a value in syntax | EsbOtlCloseOutline
(hOutline) |
" " | Double quotes enclose text parameters or parameters that include a space | "appName"
SETDEFAULTCALC "CALC ALL"; |
() | Parentheses enclose function parameters, show order of execution for operations | EsbOtlDeleteMember
(a + b) * c |
// | Comment marker indicates text from // to end of line should be ignored in processing |
// Gets results |
; | Statement terminator marks end of command | EXIT; |
API function entries supply the following kinds of information:
Description | Brief description of the function. |
Syntax | Function syntax. Function name and required keywords: bold. Parameters: italics. |
Parameters | Definitions of the parameters of the function. |
Return Value | Value returned by the function. |
Notes |
|
Access | Level of security or other access required to use the function. |
Example |
How to use the function. |
See Also | Related functions |
The Essbase documentation set includes: