MaxL Language Definition

When using special characters in MaxL terminals, note the quoting rules.

If the name contains any allowed special characters, it must be enclosed in single quotation marks. Only the following special characters are allowed by Essbase within application names:

% (percent sign)
$ (dollar sign)
- (minus sign)
{ (open brace)
} (close brace)
( (open parenthesis)
) (close parenthesis)
! (exclamation mark)
~ (tilde)
` (accent mark)
# (pound sign)
& (ampersand)
@ (at sign)
^ (caret)

A shorthand name used in the in the CREATE PARTITION statement for referring to an already-specified member expression that designates which areas of the databases should be partitioned.

Example:
In the create partition statement below, "foo" is an area-alias for the member expression specified in the area specification. To create area-aliases, enter the alias names after the member expression in each area specification. To specify which area is relevant when mapping members (if applicable), refer to its alias name in the mapped phrase.

In the example below, the alias name as created is shown in this color, and it specifies which area (in other words, it refers to the entire member expression string, '@IDESCENDANTS(East) @IDESCENDANTS(Qtr1)'). The alias name as referenced is shown in this color.

Valid values can be anything representing private data needed to authenticate the user with the authentication protocol. For example, in an LDAP schema, default connection parameters would be the portion of the DN (Distinguished Name) other than the user name, followed by @hostname:port_number.

Example: 'ou=Groups, dc=yahoo, dc=com@server2:389'

The parameter list must be enclosed in single-quotation marks, so that MaxL can interpret it as one string.

• name1 - Application name.
• name2 - Database name (not required for application-level calcs).
• name3 - Calc script name.

A stored calculation.

For calculations associated with databases, three tokens are required, to indicate application and database context and the calculation name.

Example: Sample.basic.'alloc.csc'

For application-level calculations, two tokens are required, indicating application context and the calculation name. When executing application-level calculations, you must specify which database to calculate using the syntax 'on database STRING.'

• Sample.'alloc.csc' is the application-level CALC-NAME.
• execute calculation Sample.'alloc.csc' on database Basic; is a way to execute the application-level calculation on a database.

If any part of the name contains special characters, it must be enclosed in single quotation marks.

A stored calculation name that is the third token of a database-level CALC-NAME.

For example, if the full database-level calc name is sample.basic.'alloc.csc', then CALC-NAME-SINGLE is 'alloc.csc'.

If any part of the name contains special characters, it must be enclosed in single quotation marks.

Example: '@COVARIANCE (expList1, expList2)'

A calculation string. The body of an anonymous (unstored) calculation, or the string used to specify the body of a stored calculation at create time.

Because calculations are terminated with a semicolon, and semicolons are special characters to MaxL, CALC-STRING should be enclosed in single quotation marks.

Example: CALC DIM(Year, Measures, Product);

80    default   24

Suffix for the name of a database directory to contain export files, to be created (upon export lro) on the server or client as $ARBORPATH/app/appname-dbname-suffix.

After export lro, the directory contains file-type LRO binary files (if applicable to the database), and the LRO-catalog export file with file-extension .exp.

For example, if for a Sample.Basic export, DBS-EXPORT-DIR is given as lros, then the sample-basic-lros directory is created in the $ARBORPATH/app directory structure. The sample-basic-lros directory contains file-type LRO binary files and the LRO-catalog export file 'sample-basic-lros.exp'.

Notes:

• MaxL creates exactly one export directory; it does not create a directory structure.
• If the specified export directory already exists, the export LRO statement will fail. This is a safeguard against overwriting existing export directories.

• name1 - The name of the application containing the database. Limit 8 characters.
• name2 - The name of the database. Limit 8 characters.

The name of a database. Two tokens are required, to indicate application context.

If the name contains any allowed special characters, it must be enclosed in single quotation marks. Only following special characters are allowed by Essbase within database names:

% (percent sign)
$ (dollar sign)
- (minus sign)
{ (open brace)
} (close brace)
( (open parenthesis)
) (close parenthesis)
! (exclamation mark)
~ (tilde)
` (accent mark)
# (pound sign)
& (ampersand)
@ (at sign)
^ (caret)

The second token of DBS-NAME. Limit 8 characters.

If the name contains special characters, it must be enclosed in single quotation marks.

Example: basic

The exact name of a directory in $ARBORPATH\app where LRO-catalog information was exported using export lro. Give only the directory name; do not give the full path. Must be enclosed in single quotation marks. The typical format is appname-dbname-suffix.

Example: 'sample-basic-out'

• file01
• 'D:\\filename'
• '$ARBORPATH/errors.txt'
• '/homes/fiona/scriptfile.msh' (UNIX file path)

• name1 - Application name.
• name2 - Database name.
• name3 - Filter name.

The name of a security filter. Three tokens are required, to indicate application and database context.

Full path for the name of a directory for LRO export files, to be created (upon export lro) anywhere on the client or server.

After export lro, the directory contains file-type LRO binary files (if applicable to the database), and the LRO-catalog export file named in the format directoryname.exp.

For example, if for a Sample.Basic export, FULL-EXPORT-DIR is given as home/temp/lros, then the lros directory structure is created under home/temp if home/temp exists. The lros subdirectory contains file-type LRO binary files and the LRO-catalog export file 'lros.exp'.

Notes:

• MaxL creates exactly one export directory; it does not create a directory structure. In the above example, if the home/temp directory structure exists, MaxL creates the lros directory as a subdirectory of home/temp, but if home/temp does not exist, MaxL will not create home/temp/lros.
• If the specified export directory already exists, the export LRO statement will fail. This is a safeguard against overwriting existing export directories.
• On Windows, use double backslashes ( \\ ) to represent backslashes in file paths. This is so that the MaxL Shell can interpret the second backslash literally, and not as an escape sequence. Example: 'C:\\temp\\lros'

• name1 - Application name.
• name2 - Function name.

The name of a custom-defined Hyperion Essbase function. Using one token indicates a global function. For a local (application-level) function, use two tokens.

The name of a custom-defined function is a unique string that begins with a letter or a @, #, $, _ symbol. The name can include alphanumeric characters or the aforementioned symbols. It is recommended that you start a function name with @.

Any token of the name that contains special characters must be enclosed in single quotation marks.

• Sample.'@COVARIANCE' (a local function)
• '@COVARIANCE' (a global function)

A string representing the full path to the directory used in the export lro statement.

Note: If importing lros from a server directory (using from server syntax of import lro), you can give just the full directory name instead of the full path, as specified by EXPORT-DIR.

The string must be enclosed in single quotation marks.

Examples:

• 'c:\\hyperion\\essbase\\app\\sample-basic-lros'
• 'c:\\hyperion\\essbase\\client\\sample-basic-lros'
• 'home/exports/temp/sample-basic-lros'
• "'$ARBORPATH\\app\\sample-basic-lros'"
  Note: If variables are used, the single-quoted string should also be enclosed in double quotes. On Windows, backslash characters used in paths must be doubled so that they are interpreted literally rather than as escape characters.)

For information about how IMPORT-DIR is created, see the grammar and definitions for export lro.

• name1 - Application name.
• name2 - Database name.
• name3 - Location alias name.

The name of a location alias referencing another database.
Example: Sample.Basic.EasternDB

• name1 - Application name.
• name2 - Macro name.

The name of a custom-defined Hyperion Essbase macro. Macro names are a shorthand way to refer to macro expansions.

The name of a macro is a unique string that begins with a letter or a @, #, $, _ symbol. The name can include alphanumeric characters or the aforementioned symbols. It is recommended that you start a macro name with @. Although macros must have unique names within a given application, a global macro and a local macro can share the same name. However, the local macro takes precedence.

To create or refer to a local (application-level) macro, use the double name (for example, Sample.'@JSUM').

Any part of the name that contains special characters must be enclosed in single quotation marks.

• Sample.'@COUNTRANGE' - Application-level (local) macro name without a signature, meaning that there are no restrictions on its arguments.
• Sample.'@COUNTRANGE(Any)' - Same as Sample.'@COUNTRANGE'. Once registered for the application, @COUNTRANGE can take any arguments.
• '@JCOUNTS' - System-level (global) macro name.
• '@JCOUNTS(single,group)' - Same as '@JCOUNTS', but with a signature restricting its arguments.

Outline member specification of members from one or more dimensions, member combinations separated by commas, or member sets defined with functions. Must be enclosed in single quotation marks.
Example: '@ANCESTORS(Qtr2)'.

If MEMBER-EXPRESSION contains MEMBER-NAMES that begin with numbers or contain special characters, then enclose those member names in double quotation marks, and the entire MEMBER EXPRESSION in single quotation marks. For example:

• create or replace filter demo.basic.numfilt no_access on '"2"';
• '@DESCENDANTS("Eastern Region"), @CHILDREN(Qtr1)'

If the name contains special characters, it must be enclosed in single quotation marks.
Examples:

• Jan
• 'New York'

If MEMBER-NAME is part of MEMBER-EXPRESSION and MEMBER-NAME begins with a number or contains special characters, enclose MEMBER-NAME in double quotation marks and enclose MEMBER-EXPRESSION in single quotation marks.

• LDAP
• MSAD

• number - Any positive number. Decimals and scientific notation are permitted. Whitespace between number and units is optional.
• units - One of the following: b, kb, mb, gb, tb (case-insensitive).
  If units are unspecified, bytes are assumed.

51040b  51040 b  11MB  11000kb  12.34gb 1234e-2gb

• name1 - Application name.
• name2 - Database name.
• name3 - Disk volume name.

The unique name of the disk volume definition. Unlike the name used when the disk volume definition was created (VOLUME-NAME), the unique disk-volume name must be a triple. The first two parts of the name specify application and database context. The third part of the name, on Windows, is a drive letter. On UNIX, it is a path to the Essbase directory.

If any part of the name contains special characters, that part must be enclosed in single quotation marks.
Examples:
sample.basic.'vol3/hyperion/essbase'
sample.basic.c.

If a Windows file path is used which contains a backslash ( \ ), it must be preceded with another backslash ( \\ ) to be interpreted correctly by the MaxL Shell. If variables are used, enclose the single-quoted string in double quotes so that the MaxL Shell knows to expand the variables.
Example:
sample.basic."'$ARBORPATH\\diskvol_area'"

The name of the substitution variable. The name can only contain alphanumeric characters and the underscore (a-z A-Z 0-9 _).

Example: curmonth

The name of the disk volume. On Windows, a drive letter. On UNIX, a path to the Essbase directory.

If the name contains special characters, it must be enclosed in single quotation marks.

Example: 'vol3/hyperion/essbase'.

If a Windows file path is used which contains a backslash ( \ ), it must be preceded with another backslash ( \\ ) to be interpreted correctly by the MaxL Shell. If variables are used, enclose the single-quoted string in double quotes so that the MaxL Shell knows to expand the variables.
Example:
"'$ARBORPATH\\diskvol_area'"