Document Conventions


This document uses several formatting styles to indicate actions you should take or types of information you need. The following table lists each document convention.

1, 2, 3 Numbered items indicate procedures to follow in a specific order.
· Bulleted items indicate a list of related items.
\ESSBASE  or
\essbase
Names of files, directories, and specific text you must type appear in This Font.
Essbase System Login dialog box Names of dialog boxes and their controls, such as buttons, text boxes, and list boxes, appear in boldface.
Installation Guide Titles of other books appear in italics. Italics also indicate important terms and special emphasis.
File > Open The greater than symbol (>) separates hierarchical menu choices.

Generic Command Organization

When appropriate, the following sections are included for the command or function being described:

COMMAND OR FUNCTION NAME

Gives a brief description of the command or function.

Syntax

Indicates how to use the command or function. The command or function appears in bold and the arguments appear in italics.

Description

Describes, in further detail, how to use this command or function.

Example

Shows examples, in this typeface, of how to use the command or function.

Notes


Syntax Conventions

To make code and examples easier to understand, this document uses the following syntax conventions.

Syntax Convention Purpose Example
UPPERCASE Command or function names in syntax. BEGINARCHIVE
bold Anything you type in as shown Type DELETEAPP FINANCE.
italic Terms, such as parameters, that you replace with a value ESSGETSTRING (hCtx, pString);

\directorypath\filename

The dimList argument...

" " Double quotation marks enclose text parameters or single parameters that include a space "appName"

SETDEFAULTCALC "CALC ALL";

! Report Writer: The report output character (bang) signals the start of report processing; this character must be on its own line ... // commands
<DESC MARKET
!
( )

Parentheses are used in a couple of ways:

  • To enclose function parameters
  • To show the order of execution of the enclosed operations
ESSGETSTRING (hCtx, pString);

(a + b) * c

// Comment markers in report scripts. Double slashes (//) indicate text from // to end of line should be ignored in processing.

// Get results

/* ... */ Comment markers in calculation scripts. The /* ... */ comment markers indicate the enclosed text should be ignored in processing.

/*Get results*/

; Statement terminator EXIT;
[] Brackets enclose optional parameters in syntax . Used with OR symbol | if there is more than one optional parameter. Do not type brackets or the OR symbol |. INDENT [ offset ]
[, numeric]

[, "text"]

Indicates an optional numeric (no quotes) or character (quoted) parameter and the comma which must precede the optional parameter. Do not type the brackets. [, year]

[, "columnName"]

{} Braces group statements for processing, enclose alternatives, one of which you must choose

Report Writer: Enclose report formatting commands

HELP { ? | commandName }

{ SUPFORMATS }

|

Syntax: OR. Separates alternatives from which you choose only one. Do not type the OR symbol.

SET AGGMISSG
ON | OFF

< Report Writer: Angle bracket precedes layout and member selection commands. <PAGE
@ Essbase functions: Precedes many Essbase function names @ABS
-> Essbase functions: Cross-dimensional operator (a hyphen followed by a greater-than sign) points to data values of specific member combinations -> (cross-dimensional operator) Price -> West = AVGRANGE

Copyright 1991-2002 Hyperion Solutions Corporation. All rights reserved.