This section contains the following topics:
The following syntax scheme applies to the creation of MaxL statements.
A MaxL statement corresponds to a sentence telling Analytic Services what to do with users and database objects. In this documentation, the grammar of MaxL statements is illustrated using railroad diagrams.
When issued via the MaxL Shell (essmsh), statements must be terminated by semicolons. Semicolons are used only to tell the shell when to terminate the statement; semicolons are not part of the MaxL language itself. Therefore, when issuing MaxL statements programmatically through Perl or API programs, do not terminate with a semicolon.
A token is a delimited sequence of characters recognized by MaxL as a single readable unit. Tokens may be singleton names, keywords, strings, or numbers. Names can have one, two, or three tokens, delimited by periods. The space delimiting tokens can be any white space: spaces, tabs, new lines, or blank lines.
A keyword is a sequence of alphabetic characters that is part of the MaxL grammar. Each keyword is recognized as one token. To be recognized as keywords, keywords cannot be enclosed in quotation marks. However, if you wish to use MaxL keywords outside of the grammar as terminals (for example, as database names or passwords), they must be enclosed in single or double quotation marks.
A terminal is something referenced in the grammar for which you provide the correct name or definition. Terminals can be names, numbers, or strings. Examples: user-name, filter-name, size-string.
A name is any string that starts with an alphabetic character, or any quoted string. Names in MaxL are used to uniquely identify databases and database objects, such as users, applications, or filters.
Names in MaxL may be one of three types:
- singletons, which are names with one token (example:
Sample
). Use a singleton name for objects that have a system-wide context: for example, applications.- doubles, which are names with two tokens. A double is two names connected by a period (example:
Sample.basic
). Use doubles to name objects with application-wide contexts, such as databases.- triples, which are names with three tokens. A triple is three names connected by two periods (example:
Sample.Basic.Calcname
). Use triples to name objects having database-wide contexts, such as filters.
A string is unquoted or quoted. An unquoted string can be any sequence of non-special characters. A quoted string can be any sequence of characters (special, alphabetic, or numeric) in the MaxL Alphabet, enclosed in single or double quotation marks.
A number is one kind of token which may be passed to Analytic Services by MaxL. To have meaning, the number must be in the correct format for the Analytic Services value it represents. In the MaxL grammar documentation, labels for numbers indicate whether the allowed number is positive, negative, an integer, or a real. See Numbers.
The MaxL alphabet consists of the following elements:
Element | Description |
---|---|
Special characters | Valid special characters: .
,
;
:
%
$
"
'
SPACE
TAB
*
+
-
= < > [ ] { } ( ) ? ! / \ | ~ ` # & @ ^ When using special characters in MaxL terminals, note the quoting rules. |
Non-special characters | Alphabetic characters and numbers. |
Alphabetic characters | Letters of the alphabet, and the underscore. [a-z, A-Z, _] |
Numbers | See Numbers |
Numbers in MaxL statements fit into one of the following categories.
INTEGER | Zero or a positive integer. Decimals and scientific notation are permitted. Examples: 0, 1, 1000, 1.3e4 |
REAL | Zero or a positive real number. Decimals and scientific notation are permitted. Examples: 0.0, 1, 1000, 1000.4, 13.1e-4 |
Terminal | Description |
---|---|
ACTION
(string) mail [smtp],[sender],[receiver1,reciever2,...],[subject] spool FILE-NAME |
The required action if a data-monitoring trigger is activated. Available actions are:
Examples:
|
ALG-CLASS (string) |
The Java class and the method representing a data-mining algorithm. Must be the fully qualified name of
the Java class that contains the logic for the algorithm. Must be enclosed in single or double quotation marks.
Example: 'com.hyperion.essbase.algorithms.Regression' |
ALG-MODE
(string) |
The task mode for the data-mining algorithm. Possible values for this string are: build .
|
ALG-NAME (name) |
The name of a data mining algorithm.
If the name contains special characters, it must be enclosed in single or double quotation marks. Examples: AssocRules Regression
|
ALT-NAME-SINGLE (name) |
The name of an alias table.
If the name contains special characters, it must be enclosed in single or double quotation marks. Examples: Region
|
APP-NAME
(name) |
The name of the application. Limit 8 characters.
If the name contains any allowed special characters, it must be enclosed in
single or double quotation marks. Only the following special characters are allowed by Analytic Services 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)Example: Sample |
AREA-ALIAS
(name) |
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 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,
create or replace replicated partition sampeast.east
Note: All area aliases used in a mapping should be associated with the target
(as in the example above), and the direction of member names listed in the mapped clause
should go from source to target.
|
AUTH-PARAMETERS
(string) |
Leave unspecified if you are implementing the Hyperion security platform. Custom Analytic Services external-authentication connection parameters. If the AUTHENTICATIONMODULE setting in the server configuration file essbase.cfg
file contains the full authentication parameters, then identified by
AUTH-PARAMETERS can be omitted from the MaxL statement.
Valid values can be anything representing private data needed to authenticate the user with the custom Analytic Services 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: The parameter list must be enclosed in single or double quotation marks, so that MaxL can interpret it as one string. |
BUFFER-ID
(number) |
A number between 1 and 4294967296. To destroy a buffer before a data load is complete, you must use the same BUFFER-ID number that was used to initialize the buffer. Only one buffer is allowed per import statement. Therefore, it is recommended to simply use a BUFFER-ID of 1. |
CALC-NAME
name1.name2.name3 (db-level calc) OR name1.name3 (app-level calc) |
A stored calculation. For calculations associated with databases, three tokens are required, to indicate application and database context and the calculation name. Example:
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.'
If any part of the name contains special characters, it must be enclosed in single or double quotation marks. |
CALC-NAME-SINGLE
(name) |
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 If any part of the name contains special characters, it must be enclosed in single or double quotation marks. |
CALC-SPEC-STRING
(string) |
An optional Analytic Services calculator-syntax specification string. Must be enclosed in single quotation marks.
Example: |
CALC-STRING
(string) |
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 or double quotation marks. Example: |
COLUMN-WIDTH
(number or default) |
A number (at least 8) representing character-width of columns; or, the keyword default,
representing 20 characters wide. Examples: 80 default 109 |
COMMENT-STRING
(string) |
A string of user-defined informational text. If the string contains special characters, it must be enclosed in single or double quotation marks. Example: 'This is a comment.' |
CONDITION
(string) |
A numeric-value-expression developed in MDX.
Must be enclosed in double quotation marks. Enclose strings containing
special characters in square brackets ([]).
Example: |
CUBE-AREA
(string) |
A cube area specification developed in MDX as a symmetric, syntactically-valid set.
The area specification must be static, for example it cannot contain Dynamic Calc members or
runtime functions such as Filter, TopSum, or BottomSum.
Must be enclosed in double quotation marks. Enclose strings containing
special characters in square brackets ([]). For information about defining
cube areas, see Set Specification in the MDX section.
Example: |
DATE
(string) |
A valid date string formatted according to these rules:
If the string contains special characters, it must be enclosed in single or double quotation marks. Examples: |
DIM-NAME
(string) |
The name of a database dimension.
If the string contains special characters, it must be enclosed in single or double quotation marks. Examples: |
DBS-EXPORT-DIR
(string) |
Suffix for the name of a database directory to contain export files, to be created
(upon export lro) on the server or client as
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
Notes:
|
DBS-NAME
(name1.name2) |
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 or double quotation marks. Only following special characters are allowed by Analytic Services 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)Example: Sample.basic |
DBS-STRING
(string) |
The second token of DBS-NAME. Limit 8 characters. If the name contains special characters, it must be enclosed in single or double quotation marks. Example: |
EXPORT-DIR
(string) |
The exact name of a directory in Example: |
FILE-NAME
(string) |
A file name or an absolute path to a file. If the string contains
special characters, it must be enclosed in single or double
quotation marks. Double quotation marks allows variable expansion; single quotation marks does not.
If the file path contains a backslash ( \ ), it must be preceded with another backslash ( \\ ) to be interpreted correctly by the MaxL Shell. Examples:
|
FILTER-NAME
(name1.name2.name3) |
The name of a security filter. Three tokens are required, to indicate application and database context. Example:Sample.basic.filt1
|
FULL-EXPORT-DIR
(string) |
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
Notes:
|
FUNC-NAME
name1.name2 (local) OR name2 (global) |
The name of a custom-defined Analytic Services 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 or double quotation marks. Example:
|
GROUP-NAME
(name) |
The name of the Analytic Services security group. Not applicable for externally stored groups.
Group names must start with a letter or a number. If the name contains any special characters,
it must be enclosed in single or double quotation marks. Example: Sales |
HOST-NAME
(name) |
The name of a computer. Example: Aspen
You can optionally use IP addresses in
place of hostnames when creating, dropping, or altering partition definitions.
For example: If you are creating, altering, or dropping a partition to or from another agent on the same computer, see Specifying Port Numbers in Partition Host Names for more information. Leading or trailing spaces in the host name are illegal and will be trimmed off. |
IMPORT-DIR
(string) |
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 or double quotation marks. Examples:
For information about how IMPORT-DIR is created, see the grammar and definitions for export lro. |
IMP-FILE
(string) |
A name or absolute path to a server-side rules file or data file, used for
import data and import dimension
statements.
If the data or rules file is specified to be on the server, the following rules apply. If the data or rules file is specified to be local (or left unspecified, in which case it is also local), skip the following and use FILE-NAME. If you are using server data_file or server rules_file, you can get the file from any application (not just the current application) by starting the IMP-FILE string using the following pattern:FILE_SEP AppName FILE_SEP DbName FILE_SEP rest_of_file_name where FILE_SEP must be either Examples: Consider the MaxL statement import database demo.basic data from server rules_file 'IMP-FILE' on error abort; If IMP-FILE is If IMP-FILE is
If the FILE_SEP string FILE_SEP string FILE_SEP pattern does not start the string,
the entire string is used as the filename, but the current application directory is assumed.
For example, if the initial file separator is omitted and IMP-FILE is incorrectly specified as
import database demo.basic data from server file '/Sample/Basic/Calcdat.txt' on error abort; Analytic Services looks for calcdat.txt inside the Sample.Basic directory, and loads the data to Demo.Basic. |
JAVACLASS.METHOD
(string) |
The java class and the method representing the custom-defined function. Must be a fully qualified java method name and signature, enclosed in single or double quotation marks. Example: 'com.hyperion.essbase.calculator.Statistics.covariance' For Java code examples and MaxL registration scripts for custom-defined functions, see Custom-Defined Calculation Function Examples |
LOCATION-ALIAS-NAME
(name1.name2.name3) |
The name of a location alias referencing another database.
|
MACRO-NAME
name1.name2 (local) OR name2 (global) |
The name of a custom-defined Analytic Services 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, Any part of the name that contains special characters must be enclosed in single or double quotation marks. Examples:
|
MACRO-EXPANSION
(string) |
Extended definition of the macro, to be substituted in wherever the registered macro name is referenced in a calculation.
If the string contains special characters, it must be enclosed in single or double quotation marks. Example: '@COUNT(SKIPMISSING,@RANGE(@@S))' For more information, see Custom-Defined Macros. |
MEMBER-EXPRESSION
(string) |
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 or double quotation marks. 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:
|
MEMBER-NAME
(name) |
The name of a database outline member.
If the name contains special characters, it must be enclosed in single quotation marks.
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. |
MODEL-ACCESSOR
(string) |
The entity in a data-mining model that accesses data. The data can be input, output, or model data. The accessor name reflects the type of data it accesses, for example, predictor or target. |
MODEL-MODE
(string) |
The task mode for the data-mining model.
Possible values for this string are: apply or test .
|
MODEL-NAME
(name) |
The name of a data-mining model to apply to create data mining results. The model must exist. |
MODULE-STRING
(string) |
Leave unspecified if you are implementing the Hyperion security platform. The name of the Analytic Services custom authentication module. Can be any string. Must be enclosed in single or double quotation marks. Supported modules are Lightweight Directory Access Protocol (LDAP) and Microsoft Active Directory. Suggested acronyms to use for MODULE-STRING are:
|
NEW-ALIAS-NAME
(name) |
The name of a new location alias you are creating from the current database to reference a remote database. Example: EasternDB |
OBJ-NAME
(name1.name2.name3) |
The name of a database object. Three tokens are required, to indicate application and database context. Example:Sample.basic.Calcdat
|
OBJ-NAME-SINGLE
(name) |
A stored database object name that is the third token of a database-level OBJ-NAME. For example, if the full database object name is If any part of the name contains special characters, it must be enclosed in single or double quotation marks. |
PASSWORD
(string) |
A user's password. Not applicable for externally authenticated users. If the string contains special characters, it must be enclosed in single or double quotation marks. Leading or trailing spaces are illegal and will be trimmed off. |
RESULT-ACCESSOR
(string) |
The entity in a data-mining result record that accesses data. The data can be input, output, or model data. The accessor name reflects the type of data it accesses, for example, predictor or target. |
RESULT-MODE
(string) |
The task mode for the data-mining result.
Possible values for this string are: apply or test .
|
RESULT-NAME
(name) |
The name of a data-mining result record. |
ROLE-NAME
(name) |
The name of the security role. For more information, see Privileges and Roles. Example: designer |
SESSION-ID
(number) |
The unique session ID. This ID can be used to logout a user session, or kill the current request in that session. Example: 3310545319 |
SIZE-STRING
(number units) OR (number) |
51040b 51040 b 11MB 11000kb 12.34gb 1234e-2gb |
SPOOL-NAME
(name1.name2.name3) |
The name of a trigger's output file, as specified in the THEN or ELSE section
of the create trigger statement. Example: In the following create trigger statement, the bold section is the spool name. create or replace trigger Sample.Basic.Trigger_Jan_20 where "(Jan,Sales,[100],East,Actual)" when Jan > 20 and is(Year.currentmember,Jan) then spool Trigger_Jan_20 end; |
STOPPING-VAL
(number) |
Optional stopping value for the execute
aggregate process statement. Use this value to give the ratio of the growth size you
want to allow during the materialization of an aggregate storage database, versus the pre-aggregation
size of the database (Before an aggregation is materialized, the database contains only level 0 input-level
data.) For example, a stopping value of 1.5 means that during the materialization of the aggregation, the aggregate cells are allowed to occupy up to 50% of the disk space occupied by the level-0 data. |
TABLSP-NAME
(name1.name2) |
default and temp .
Other tablespace names reserved by the system are metadata and log .
|
TASK-MODE
(string) |
The mode for the data-mining task template.
Possible values for this string are: build , apply , test or score .
|
TASK-NAME
name |
The name of a data-mining build, apply, or test template. You use a template to create the corresponding model. |
TASK-XML-STRING (string) |
A string of XML representing a data-mining task to execute. Must be enclosed in single quotation marks.
There are several ways of obtaining the XML string. For the build task, the XML can be obtained either
from You may need to do the following before pasting the XML string into a MaxL statement:
|
TRANSF-CLASS (string) |
The Java class and the method representing a data-mining transformation. Must be the fully qualified name of
the Java class that contains the logic for the transformation. Must be enclosed in single quotation marks.
Example: com.hyperion.essbase.transformations.Log |
TRANSF-NAME
(name) |
The name of a data-mining transformation. |
TRIGGER-NAME
name1.name2.name3 |
The name of the trigger device created to track and respond to database updates. Trigger names must be triple names, specifying application name, database name, and trigger name (f you rename the application or database, the trigger is invalidated). Trigger names are case-insensitive, are a maximum of 30 bytes, and cannot contain special characters. Example: |
UNIQUE-VOL-NAME
(name1.name2.name3) |
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 If any part of the name contains special characters, that part must be enclosed in single or double quotation marks. 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. |
USER-NAME
(name) |
The name of the user. If the name contains special characters, it must be enclosed in single or double quotation marks. User names can contain any characters except for the backslash (\). User names must begin with a letter or a number. Leading or trailing spaces are illegal and will be trimmed off. If the user is being created for authentication on the Hyperion security platform, the name must match a valid login name on one of the configured corporate authentication repositories. |
VARIABLE-NAME
(name) |
The name of the substitution variable. The name can only contain alphanumeric characters and the underscore Example: |
VOLUME-NAME
(name) |
The name of the disk volume. On Windows, a drive letter. On UNIX, a path to the If the name contains special characters, it must be enclosed in single or double quotation marks. Example: 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. |
Analytic Services system privileges are indivisible database access types. In MaxL, privileges are grouped together to form permission-sets called roles.
With the exception of create_user
and create_application
, privileges themselves
are not grantable using MaxL; you typically grant roles, which are the equivalent of privilege levels. The scope of a role can be
the system, the application, or the database.
While one privilege does not imply another, roles are hierarchical. The following table illustrates the Analytic Services system privileges that are contained in each MaxL system role.
MaxL System Role | Analytic Services System Privileges | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
read | write | calculate | design database |
create database |
start application |
design application |
create/drop application |
create/drop user |
||
no access | . | . | . | . | . | . | . | . | . | |
read | ![]() |
. | . | . | . | . | . | . | . | |
write | ![]() |
![]() |
. | . | . | . | . | . | . | |
execute | ![]() |
![]() |
![]() |
. | . | . | . | . | . | |
designer (database) | ![]() |
![]() |
![]() |
![]() |
. | . | . | . | . | |
designer (application) | ![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
. | . | |
supervisor | ![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
The following privileges apply at the system level. These privileges are built-in; they do not apply to any specific application or database. They are not included in any role except for the role of supervisor.
create_application | Ability to create and delete applications. |
create_user | Ability to create and delete users and groups. |
System-level system roles are applicable to the Analytic Services system. The following roles have a system-wide scope:
no_access | No access to the system. |
supervisor | Full access to the entire system, including other supervisors. |
Application-level system roles are applicable to an application. The following roles may have an application-wide scope:
no_access | No access to the application or any databases within it. |
designer | Designer access to the application and any databases within it. Designer access means ability to create, delete, and modify databases within the application, in addition to having Read, Write, and Execute access for that application. |
Database-level system roles are applicable to databases. The following roles have a database-wide scope and are available when assigning minimum database permissions:
no_access | No access to the database (if assigned using alter database) or to any databases in the application (if assigned using alter application). |
read | Read-only access to the database (if assigned using alter database) or to all databases in the application (if assigned using alter application). Read access means ability to view files, retrieve data values, and run report scripts. |
write | Write access to the database (if assigned using alter database) or to all databases in the application (if assigned using alter application). Write access means ability to update data values, in addition to having Read access. |
execute | Calculate access to the database (if assigned using alter database) or to all databases in the application (if assigned using alter application). Calculate access means ability to update data values, in addition to having Read and Write access. |
designer | Designer access to the database (if assigned using alter database) or to all databases in the application (if assigned using alter application). Designer access means ability to modify database outlines, in addition to having Read and Write access. |
The following database-level system roles are available for granting to users and groups:
no_access | No access to the database. |
read | Read-only access to the database. Read access means ability to view files, retrieve data values, and run report scripts. |
write | Write access to the database. Write access means ability to update data values, in addition to having Read access. |
designer | Designer access to the database. Designer access means ability to modify database outlines, in addition to having Read and Write access. |
Note: After granting read, write, or designer privilege to a user or group, these can be revoked by subsequently granting no_access. However, to prevent users from being able to load the application, you should also grant no_access at the application level. For example:/* Grant read permission on a database */ grant read on database Sample.Basic to user1; /* Revoke read permission on the database */ grant no_access on database Sample.Basic to user1; /* Revoke read permission at the application level, to remove application-startup permission */ grant no_access on application Sample to user1;
The following subset of database-level system roles may be granted or revoked using filters.
no_access | No access to the specified data object. |
read | Read-only access to the specified data object. Read access means ability to view files, retrieve data values, and run report scripts. |
write | Write access to the specified data object. Write access means ability to update data values, in addition to having Read access. |
meta_read | Restricted access to sibling and ancestral metadata (dimensions and members). In case of a filtering conflict, the MetaRead filtering overrides the other filter permissions. For more information about metatdata filtering, see Metadata Filtering. |
Note: After granting permissions using a filter, the permission can be revoked by subsequently granting no_access to the database. However, to prevent users from being able to load the application, you should also grant no_access at the application level. For example:/* Grant read permission on a database, using a filter */ grant filter Sample.basic.filter8 to user1; /* Revoke the filter, removing read permission on the database */ grant no_access on database Sample.Basic to user1; /* Revoke read permission at the application level, to remove application-startup permission */ grant no_access on application Sample to user1;
These rules apply to terminals of MaxL statements; for example, USER-NAME or FILE-NAME. Rules for MaxL Shell also apply.
Tokens enclosed in single quotation marks
Tokens enclosed in double quotation marks
Use of backslashes
Use of apostrophes
Use of dollar signs
Contents are preserved as literal, with the following exceptions:
Example: export database sample.basic data to data_file 'D:\\export.txt';
Result: Exports data to D:\export.txt
.
Example: create user 'O'Brian' identified by 'password';
Result: Error.
Example: create user 'O\'Brian' identified by 'password';
Result: User O'Brian
is created.
Contents are preserved as literal, with the following exceptions:
Example: export database sample.basic data to data_file "D:\\export.txt";
Result: Exports data to D:\export.txt
.
Example: export database sample.basic data to data_file "$ARBORPATH\\App\\Sample\\Basic\\export.txt";
Result: Exports data to C:\Hyperion\Essbase\App\Sample\Basic\export.txt
.
Example: create user "O'Brian" identified by 'password';
Result: Error.
Example: create user "O\'Brian" identified by 'password';
Result: Error. Use single quotation marks instead of double quotation marks.
Ignored unless preceded by another backslash (the escape character). Must use single quotation marks around the token containing the two backslashes.
create application 'finance\\budget';
Result: Application finance\budget
is created.
Example (Windows):
export database sample.basic using report_file 'Essbase\\App\\Sample\\Basic\\asym.rep' to data_file 'c:\\home\\month2.rpt';
Result: The Windows file paths are interpreted correctly as
Essbase\App\Sample\Basic\asym.rep
and c:\home\month2.rpt
.
Syntax error returned, unless preceded by a backslash (the escape character) and enclosed in single quotation marks.
Example:create user 'O\'Brian' identified by 'password';
Result:
User O'Brian
is created.
Note: Use sparingly. Apostrophes are permitted by Analytic Services in user and group names, but not in application or database names.
Syntax error returned, unless preceded by a backslash (the escape character) and enclosed in single quotation marks. Dollar signs ($) intended literally need to be escaped by the backslash so that they are not considered variable indicators.
Example:create application '\$App1';
Result:
Application $App1
is created.
©2004 Hyperion Solutions Corporation. All Rights Reserved. http://www.hyperion.com |