ESSCMD Commands List

New ESSCMD Commands in Release 6.1

Updated ESSCMD Commands in Release 6.1

ADDUSER

The ADDUSER command adds a user to a group.

Syntax

ADDUSER groupName userName

Description

Use groups to classify users with identical security requirements.

Example

To add the user TomT to the group named MARKETING:

ADDUSER "Marketing" "TomT";

APPLYOTLCHANGEFILE

The APPLYOTLCHANGEFILE command applies the outline changes specified in the .CHG log file to the target database's outline you selected with the SELECT command.

Syntax

APPLYOTLCHANGEFILE numFiles fileName

Description

When the source database outline is modified, the GETPARTITIONOTLCHANGES command records the outline changes to a .CHG file in the source database directory.
Use the APPLYOTLCHANGEFILE command after calling the GETPARTITIONOTLCHANGES command. APPLYOTLCHANGEFILE applies the source database outline changes to the target database. You must specify the full path to the source database's .CHG file.

Example

APPLYOTLCHANGEFILE 1 "C:\Hyperion\Essbase\App\Sampeast\East\ess00004.chg"; 

See also

GETPARTITIONOTLCHANGES

ARCHIVE

The ARCHIVE command is retained for backward compatibility. When you run the ARCHIVE command, Hyperion Essbase returns an informational message. Use the BEGINARCHIVE and ENDARCHIVE commands.

See also

BEGINARCHIVE
ENDARCHIVE

BEGINARCHIVE

The BEGINARCHIVE command places a database in Read-only mode for archiving.

Syntax

BEGINARCHIVE App DB file

Description

Changing the server mode to Read-only allows the database administrator to use an archiving program to back up all the files on the server. This also prevents writing to the files during backup.

The server's Read-only state persists until it is changed back to Read-write with the ENDARCHIVE command. Unless you reset the Read-only state, it persists even after termination of the current session.

The database files to back up are listed in the application\database directory specified by the filename parameter. The archived data overwrites the information in the specified file, if the file already exists. See the Database Administrator's Guide for more information about restructuring and backup files.

Example

BEGINARCHIVE "Sample" "Sales" "June";

BEGININCBUILDDIM

The BEGININCBUILDDIM command prepares Hyperion Essbase for upcoming incremental dimension-building commands.

Syntax

BEGININCBUILDDIM

Description

This command works in conjunction with the ENDINCBUILDDIM command to group together one or more INCBUILDDIM statements.

This commands locks the outline file. If the outline file is already locked, this command returns an error.

This command copies the outline file (.OTL) to a backup file name (.OTN). Subsequent INCBUILDDIM commands operate on the .OTN file. See the Database Administrator's Guide for more information about restructuring and backup files.

BEGININCBUILDDIM starts a programming block; ENDINCBUILDDIM ends the programming block.

Example

To build the dimensions specified in GENREF.RUL and LEVELMUL.RUL, discard all data, and save the new outline after the dimension builds are complete:

BEGININCBUILDDIM;
INCBUILDDIM 2 "GENREF.RUL" 2 "GENREF.TXT" 4 "ERR.OUT" 1;
INCBUILDDIM 2 "LEVELMUL.RUL" 2 "LEVELMUL.TXT" 4 "ERR.OUT" 1;
ENDINCBUILDDIM 4;

See also

ENDINCBUILDDIM
INCBUILDDIM
BUILDDIM

BUILDDIM

Use the BUILDDIM command to dynamically build one or more dimensions from a data file or SQL source.

Syntax

BUILDDIM location rulobjName dataLoc sourceName fileType errorLog

Description

This command builds one or more dimensions from a data file or an SQL source. Many applications have large dimensions that are impractical to manually define and maintain. This command makes it possible to automate the dimension-building and updating processes. See the INCBUILDDIM command for another way to build dimensions.

The INCBUILDDIM command is identical to the BUILDDIM command, except for the following:

• INCBUILDDIM does not automatically restructure the database after modifying the dimensions. You can have several consecutive INCBUILDDIM commands inside a BEGININCBUILDDIM...ENDINCBUILDDIM block. Hyperion Essbase restructures when it encounters ENDINCBUILDDIM.
• INCBUILDDIM lets you append to, rather than overwrite, the error log.

Example

To build the dimensions as defined by the rules file, PROD.RUL:

BUILDDIM 1 "PROD" 1 "PRODUCTS" 4 "PRODERR";

To build the dimensions from an SQL table defined in the rules file, PROD.RUL:

BUILDDIM 1 "PROD" 4 "TomT" Password "PRODERR";

CALC

The CALC command executes one or more calculation strings.

In interactive ESSCMD, you can enter multiple strings, one at a time.

Syntax

CALC "calcString; [calcString;]"

Description

In a batch file, if you include multiple calculation strings in one CALC command, place all of the calculation string parameters in one set of quotation marks and end each command string with a semicolon statement terminator (;). All text within the quotation marks is passed to the calculator.

As an alternate to including multiple calculation strings in this command, place the strings in a calculation script, then call RUNCALC to run the script.

Example

To issue the CALC ALL command:

CALC "Calc All;";

To calculate the members January and Product:

CALC "Jan; Product;";

See also

CALCLINE

CALCDEFAULT

The CALCDEFAULT command calculates the default database calculation.

Syntax

CALCDEFAULT

Description

It calculates the relationships defined in the outline or a calc string that is set to the default calculation.

Example

CALCDEFAULT;

See also

CALC
CALCLINE
SETDEFAULTCALC

CALCLINE

The CALCLINE command executes a single calculation string.

Syntax

CALCLINE calcString

Description

This command executes a single calculation string. In a batch file, place the calculation string parameter in quotation marks and end the string with a semicolon statement terminator (;). All text within the quotation marks is passed to the calculator. This command requires quotation marks.

Example

To issue the CALC ALL command:

CALCLINE "Calc All;";

To calculate the members January and Product:

CALCLINE "Jan; Product;";

See also

CALC

COMMITDB

The COMMITDB command is retained for backward compatibility and is no longer used. When the Transaction Isolation Level is Committed access, Hyperion Essbase handles commits automatically. When the Transaction Isolation Level is Uncommitted access, you can specify a commit threshold.

See SETDBSTATEITEM for more information.

COPYAPP

The COPYAPP command copies an application.

Syntax

COPYAPP sourceApp destApp

Description

This command copies an application.

Example

COPYAPP "FINANC95" "FINANC96";

COPYDB

The COPYDB command copies a database.

Syntax

COPYDB sourceApp sourceDb destApp destDb

Description

Example

COPYDB "FINANC95" "SALES95" "FINANC96" "SALES96";

COPYFILTER

The COPYFILTER command copies a filter.

Syntax

COPYFILTER sourceApp sourceDb sourceFilter destApp destDb destFilter

Description

Example

COPYFILTER "FINANC95" "SALES95" "FILTER95" "FINANC96" "SALES96" "FILTER96";

COPYOBJECT

The COPYOBJECT command copies a database object.

Syntax

COPYOBJECT objType sourceApp sourceDb sourceObj destApp destDb destObj

Description

Two values for the objType parameter, 6 and 7, are retained only for backward compatibility with Release 2.0.

Example

COPYOBJECT "2" "FINANC95" "SALES95" "OLDOBJ" "FINANC96" "SALES96" "NEWOBJ";

CREATEAPP

The CREATEAPP command creates a new application.

Syntax

CREATEAPP appName

Description

Example

To create an application called TBC:

CREATEAPP "TBC";

CREATEDB

The CREATEDB command creates a database.

Syntax

CREATEDB appName dbName

Description

You can create a database for any application that already exists on the server.

Example

To create an database called FINANCE under an application named TBC:

CREATEDB "TBC" "FINANCE";

CREATEGROUP

The CREATEGROUP command creates a group.

Syntax

CREATEGROUP groupName

Description

This command creates a new group. Groups classify users with identical security privileges.

Example

To create a group called MARKETING:

CREATEGROUP "MARKETING";

CREATELOCATION

The CREATELOCATION command creates a new location alias at the database level.

Syntax

CREATELOCATION alias host application database user_name password

Description

Location aliases provide a shorthand way of managing login information for Hyperion Essbase databases. Location aliases are mapped to a host name, application name, database name, user name, and password.

Notes:

• In this release, you can use location aliases only with the @XREF function.
• You must have Database Designer privilege to create location aliases.

Example

CREATELOCATION "ALIAS3" "LOCAL" "SAMPLE" "BASIC" "TomT" "PASSWORD";

See also

DELETELOCATION
LISTLOCATIONS

CREATEUSER

The CREATEUSER command creates a new user ID.

Syntax

CREATEUSER userName password

Description

This command creates a new user ID and password.

Example

To create a user named DANTE with the password INFERNO:

CREATEUSER "DANTE" "INFERNO";

CREATEVARIABLE

The CREATEVARIABLE command defines a new substitution variable and its corresponding string value on the server.

Syntax

CREATEVARIABLE variableName serverName [appName [dbName]] value

Description

This command creates a new substitution variable on the server. If you specify only the server name, the variable applies to all applications and databases on the server. If you specify the server and application name, the variable applies to all databases within the specified application. If you specify the server, application, and database, the variable is available only within the specified database.

Before you create a new variable, check the names of existing variables with the LISTVARIABLES command. It is possible to overwrite the string value of an existing variable if you create a variable with the same name as the existing variable.

Example

CREATEVARIABLE "CurQtr" "Bamboo" "Sample" "Basic" "Qtr1";

See also

LISTVARIABLES

DEFRAG

The DEFRAG command is no longer used. Starting with Release 5.0, defragmentation of data freespace is performed dynamically by the Hyperion Essbase kernel.

DELETEAPP

The DELETEAPP command deletes an application.

Syntax

DELETEAPP appName

Description

Deleting an application deletes all of its associated databases and other objects, along with any additional files that reside in the application and database directories.

Example

To delete an application called TBD:

DELETEAPP "TBC";

DELETEDB

The DELETEDB command deletes a database.

Syntax

DELETEDB appName dbName

Description

Deleting a database deletes all of its associated objects, along with any additional files that reside in the database directory.

Example

To delete a database called BASIC from an application called TBC:

DELETEDB "TBC" "BASIC";

DELETEGROUP

The DELETEGROUP command deletes a group.

Syntax

DELETEGROUP groupName

Description

Example

To delete a group called MARKETING:

DELETEGROUP "MARKETING";

DELETELOCATION

The DELETELOCATION command removes a location alias from the current database.

Syntax

DELETELOCATION alias

Description

This command deletes the specified location alias from the current database. You must have Database Designer privilege to delete location aliases.

Example

DELETELOCATION "ALIAS3";

See also

CREATELOCATION
LISTLOCATIONS

DELETELOG

The DELETELOG command deletes an application log file or the Agent log file.

Syntax

DELETELOG appName

Description

Each application has a log file, which records all user requests and activities in all databases in the application. The log file should be deleted regularly to prevent its becoming too large.

In addition, there is an Agent log file, which records all the commands displayed in the main Agent window. If you do not specify the appName parameter, Hyperion Essbase deletes the Agent log file.

Example

To delete the log file of an application called SAMPLE:

DELETELOG "SAMPLE";

To delete the Agent log file:

DELETELOG ""

DELETEUSER

The DELETEUSER command deletes a user ID.

Syntax

DELETEUSER userName

Description

Deleting the user ID deletes the user from the list of users on the Hyperion Essbase server, as well as logging the user out of the active session.

Example

To delete a user named DANTE:

DELETEUSER "DANTE";

DELETEVARIABLE

The DELETEVARIABLE command removes an existing substitution variable.

Syntax

DELETEVARIABLE variableName serverName [appName [dbName]]

Description

This command deletes the selected substitution variable definition. If the variable was created at the server level, specify only the server name, and delete the variable. If the variable was created at the application level, specify the server and application, then delete the variable. If the variable was created at the database level, select the server, application, and database, then delete the variable.

Example

DELETEVARIABLE "CurQtr" "Bamboo" "Sample" "Basic";

DISABLELOGIN

The DISABLELOGIN command is used to prevent users from logging in to an application. Supervisors, and application designers for the application, are not affected by this setting.

Syntax

DISABLELOGIN [appName]

Description

Issue the DISABLELOGIN command if you must prevent users from accessing an application while you perform maintenance on it. Supervisors, and users currently connected to the application, will not be affected.

Example

DISABLELOGIN;

DISPLAYALIAS

The DISPLAYALIAS command lists the alias names defined in an alias table.

Syntax

DISPLAYALIAS aliasTableName

Description

Alias tables contain sets of aliases for member names and are stored in the database outline. Use this command to see a list of alias names defined in this table.

Example

To display the alias names defined in an alias table called DEFAULT:

DISPLAYALIAS "DEFAULT";

ENABLELOGIN

The ENABLELOGIN command is used to enable connections to an application.

Syntax

ENABLELOGIN [appName]

Description

This command enables connections to an application.

Example

ENABLELOGIN;

ENDARCHIVE

The ENDARCHIVE command restores the database to Read-write mode after archiving is complete.

Syntax

ENDARCHIVE appName dbName

Description

After you call BEGINARCHIVE, use ENDARCHIVE to restore Read-write mode. Otherwise, the Read-only state persists even after the termination of the current session. See the Database Administrator's Guide for more information about restructuring and backup files.

Example

ENDARCHIVE;

See also

BEGINARCHIVE

ENDINCBUILDDIM

The ENDINCBUILDDIM command ends the programming block started by BEGININCBUILDDIM and restructures the database after one or more incremental, dimension-building (INCBUILDDIM) commands.

Syntax

ENDINCBUILDDIM preserve

Description

This command works in conjunction with the BEGININCBUILDDIM command to group together one or more INCBUILDDIM statements.

This command restructures the database according to the dimension changes that occur as a result of the INCBUILDDIM commands.

This command preserves existing data according to the preserve option.

This command unlocks the outline once restructuring is complete, and overwrites the original .OTL file with the newly modified .OTN file. See BEGININCBUILDDIM for information.

If one or more of the INCBUILDDIM commands that precede the ENDINCBUILDDIM command fails, ENDINCBUILDDIM still restructures the database.

WARNING: If you don't issue an ENDINCBUILDDIM command after a BEGININCBUILDDIM command and one or more INCBUILDDIM commands, the changes made to the .OTN file are not copied to the database outline (.OTL) file, and the data is not restructured.

Example

To build the dimensions specified in GENREF.RUL and LEVELMUL.RUL, discard all data, and save the new outline after the dimension builds are complete:

BEGININCBUILDDIM;
    INCBUILDDIM 2 "GENREF.RUL" 2 "GENREF.TXT" 4 "ERR.OUT" 1;
    INCBUILDDIM 2 "LEVELMUL.RUL" 2 "LEVELMUL.TXT" 4 "ERR.OUT" 1;
    ENDINCBUILDDIM 4;

See also

BEGININCBUILDDIM
INCBUILDDIM

EXIT

The EXIT command is used to exit the ESSCMD utility.

Syntax

EXIT

Description

This command ends the ESSCMD session and closes the window.

Example

EXIT;

EXPORT

The EXPORT command dumps the data values of a database to an ASCII text file. If no path is specified, the file is created in the ARBORPATH\app directory.

Syntax

EXPORT exportName amount formatOption

Description

This command transfers data across databases as a faster alternative to database archiving. This command exports only the data, rather than the entire database. Because of this, it is more complex to restore the database from an export file than from a true database archive. You must reload and recalculate exported data if you use it to restore a database.

The export file cannot exceed the file-size limitations for your operating system.

Example

To create an export file called E060693 that contains only level zero data in columnar format:

EXPORT "E060693" 2 1;

GETALLREPLCELLS

The GETALLREPLCELLS command replicates all data cells in the replicated partition from a data source database to the selected data target database. Use this command when you are in the data target database.

Syntax

1. GETALLREPLCELLS sourceServerName sourceAppName sourceDbName
2. GETALLREPLCELLS ALL

Description

This command gets all replicated data cells from the data source server, application, and database, and replicates them in the data target database you select with the SELECT command. This is useful when the data source and data target databases are out of synch and need to be resynchronized.

GETALLREPLCELLS gets cells from the data source server to the data target server, based on a request made from the data target server; PUTALLREPLCELLS cells puts cells from the data source server to the data target server, based on a request made from the data source server.

Example

GETALLREPLCELLS "Aspen" "Sample" "Basic";

See also

GETUPDATEDREPLCELLS
PUTALLREPLCELLS

GETAPPACTIVE

The GETAPPACTIVE command returns the name of the currently selected application.

Syntax

GETAPPACTIVE

Description

This command returns the name of the currently selected application.

Example

GETAPPACTIVE;

See also

GETAPPINFO
GETAPPSTATE

GETAPPINFO

The GETAPPINFO command returns server, user, and database information for the current application.

Syntax

GETAPPINFO [appName]

Description

This command returns the following information about the current application: name, server name, status, elapsed apptime, users connected, number of databases, list of all databases within the application.

Example

GETAPPINFO;

See also

GETAPPACTIVE
GETAPPSTATE

GETAPPSTATE

The GETAPPSTATE command returns information on the state of the currently selected application.

Syntax

GETAPPSTATE [appName]

Description

This command returns information on the state of the currently selected application, as follows:
Loadable (Y/N) AutoLoad (Y/N), Access Level, Allow Connects (Y/N), Allow Commands (Y/N),
Allow Updates (Y/N), Security, Lock Timeout, LRO File Size Limit.

Example

GETAPPSTATE;

See also

GETAPPACTIVE
GETAPPINFO

GETATTRIBUTESPECS

The GETATTRIBUTESPECS command returns the current attribute specifications for the selected application and database.

Syntax

GETATTRIBUTESPECS

Description

This command returns the current attribute specifications for the currently selected application and database. These specifications include attribute member name format, Attribute Calculation dimension member names, Boolean and date member names, and numeric range specifications. These settings are defined in Outline Editor.

Example

GETATTRIBUTESPECS;

 ---------Attribute Specifications--------


 Prefix/Suffix   : Prefix
 Use Name of     : Parent
 Delimiter       : '_'
 Date Format     : MM-DD-YYYY
 Bucketing Type  : Upper Bound inclusive
 Default for TRUE       : True
 Default for FALSE      : False
 Default for Attr Calc  : Attribute Calculations
 Default for Sum        : Sum
 Default for Count      : Count
 Default for Average    : Average
 Default for Min        : Min
 Default for Max        : Max

The name of the attribute level 0 member 3000000, in the following dimension structure, varies depending on the attribute member name format.

Attribute Member:

Population 
      Small
	    3000000

Sample Name Variations:

Settings	Prefix/Suffix : Prefix Use Name of : None Delimiter : '_'
Member name	3000000

Settings	Prefix/Suffix : Prefix Use Name of : Parent Delimiter : '_'
Member name	Small_3000000

Settings	Prefix/Suffix : Prefix Use Name of : All Ancestors Delimiter : '^'
Member name	Population^Small^3000000

GETATTRINFO

The GETATTRINFO command returns attribute member, dimension, and name information for given attribute members.

Syntax

GETATTRINFO mbrName

mbrName

Full attribute member name, as defined in Outline Editor > Settings > Attribute Member Names > Member Name Format tab. Example: Intro Date_07-26-1996

Description

This command returns the following information for a member of an attribute dimension:

• MbrName: Member name.
• DimName: Dimension of which the attribute is a member.
• Data Type: The attribute member type. Values: Boolean, date, numeric, text.
• Data Value: The short attribute member name, if an attribute member. This is the name shown in the Outline Editor. For example, Data Value = 20 for the attribute member named Ounces_20.

Notes

• The output of this command is a subset of the output for the GETMBRINFO command.
• If you do not know the exact format of the attribute member name, enter GETMEMBERS <parent>, where <parent> is the parent of the attribute member. For example, GETMEMBERS "Intro Date"; returns:
  

  Intro Date_12-10-1996   Intro Date_10-01-1996   Intro Date_07-26-1996
  Intro Date_06-26-1996   Intro Date_04-01-1996   Intro Date_03-25-1996
  Intro Date_09-27-1995   Intro Date 
  

Example

GETATTRINFO "Caffeinated_True";

Returns:

Member info of [caffeinated_true]
------------------------------------
MbrName      : Caffeinated_True
DimName      : Caffeinated
Attribute Type    : Boolean
Attribute Value   : True

GETCRDB

The GETCRDB command returns the name of the currency database that is linked to the currently selected database.

Syntax

GETCRDB

Description

This command returns the name of the currency database that is linked to the currently selected database.

Example

GETCRDB;

See also

GETCRDBINFO
GETCRRATE
GETCRTYPE

GETCRDBINFO

The GETCRDBINFO command returns information about the currency database that is linked to the currently selected database.

Syntax

GETCRDBINFO

Description

This command returns information about the currency database that is linked to the currently selected database.

Example

GETCRDBINFO;

GETCRRATE

The GETCRRATE command returns the currency rate for every currency partition.

Syntax

GETCRRATE

Description

This command returns the currency rate for every currency partition.

Example

GETCRRATE;

See also

GETCRDB
GETCRDBINFO

GETCRTYPE

The GETCRTYPE command returns information about the default currency type and conversion method.

Syntax

GETCRTYPE

Description

This command returns information about the default currency type and conversion method.

Example

GETCRTYPE;

See also

GETDBINFO
GETDBSTATS

GETDBACTIVE

The GETDBACTIVE command returns the name of the currently selected database.

Syntax

GETDBACTIVE

Description

This command returns the name of the currently selected database.

Example

GETDBACTIVE;

GETDBINFO

The GETDBINFO command returns information on the state of the currently selected database.

Syntax

GETDBINFO [appName dbName]

Description

This command returns database-state information currently in effect for the selected database. Note that some settings do not take effect until the database is stopped and re-started. For information on most recently entered settings, see GETDBSTATE.

Example

GETDBINFO;

----- Database Information -----

Name                                : Basic
Application Name                    : Sample
Database Type                       : NORMAL
Status                              : Loaded
Elapsed Db Time                     : 00:01:38:31
Users Connected                     : 2
Blocks Locked                       : 0
Dimensions                          : 11
Data Status                         : Data has been modified
                                      since last calculation.
Data File Cache Size Setting        : 33554432
Current Data File Cache Size        : 8388608
Data Cache Size Setting             : 3144960
Current Data Cache Size             : 2096064
Index Cache Size Setting            : 10485760
Current Index Cache Size            : 10485760
Index Page Size Setting             : 1024
Current Index Page Size             : 8192
Cache Memory Locking                : Enabled
Database State                      : Read-write
Data Compression on Disk            : Yes
Data Compression Type               : BitMap Compression
Retrieval Buffer Size (in K)        : 10
Retrieval Sort Buffer Size (in K)   : 10
Isolation Level                     : Uncommitted Access
Pre Image Access                    : No
Time Out                            : Never
Number of blocks modified before internal commit   : 3000
Number of rows to data load before internal commit : 0
Number of disk volume definitions      : 0

--Currency Info--

Currency Country Dimension Member    :
Currency Time Dimension Member       : Year
Currency Category Dimension Member   : Measures
Currency Type Dimension Member       :
Currency Partition Member            :

--Request Info--

Request Type     : Data Load
User Name        : admin
Start Time       : Mon Aug 16 11:42:59 1999
End Time         : Mon Aug 16 11:43:22 1999
Request Type     : Default Calculation
User Name        : admin
Start Time       : Thu Aug 12 12:57:45 1999
End Time         : Thu Aug 12 12:57:46 1999
Request Type     : Outline Update
User Name        : admin
Start Time       : Mon Aug 16 12:39:27 1999
End Time         : Mon Aug 16 12:39:30 1999

GETDBSTATE

The GETDBSTATE command returns the most recently entered database settings information for the currently selected database.

Syntax

GETDBSTATE [appName dbName]

Description

This command returns the most recently entered settings for the currently selected database. For settings currently in effect, see GETDBINFO.

Example

GETDBSTATE;

---------Database State---------

Description:
Allow Database to Start                : Yes
Start Database when Application Starts : Yes
Access Level                           : None
Data File Cache Size                   : 33554432
Data Cache Size                        : 3145728
Aggregate Missing Values               : No
Perform two pass calc when [CALC ALL;] : Yes
Create blocks on equation              : No
Currency DB Name                       : N/A
Currency Conversion Type Member        : N/A
Currency Conversion Type               : N/A
Index Cache Size                       : 10485760
Index Page Size                        : 1024
Cache Memory Locking                   : Disabled
Data Compression on Disk               : Yes
Data Compression Type                  : BitMap Compression
Retrieval Buffer Size (in K)           : 10
Retrieval Sort Buffer Size (in K)      : 10
Isolation Level                        : Uncommitted Access
Pre Image Access                       : Yes
Time Out after                         : 20 sec.
Number of blocks modified before internal commit   : 3000
Number of rows to data load before internal commit : 0
Number of disk volume definitions      : 0

GETDBSTATS

The GETDBSTATS command returns detailed statistics for the currently selected database.

Syntax

GETDBSTATS

Description

This command returns information about dimensions and data blocks for the currently selected database.

Example

GETDBSTATS;

-------Statistics of sample:basic -------

Dimension Name         Type    Declared Size  Actual Size
=========================================================
Year                   DENSE   20             12
Measures               DENSE   17             9
Product                SPARSE  22             19
Market                 SPARSE  25             25
Scenario               DENSE   5              2
Caffeinated            SPARSE  3              3
Intro Date             SPARSE  8              8
Ounces                 SPARSE  5              5
Pkg Type               SPARSE  3              3
Population             SPARSE  15             15

Number of dimensions                          : 10
Declared Block Size                           : 1700
Actual Block Size                             : 216
Declared Maximum Blocks                       : 550
Actual Maximum Blocks                         : 475
Number of Non Missing Leaf Blocks             : 177
Number of Non Missing Non Leaf Blocks         : 197
Number of Total Blocks                        : 374
Index Type                                    : B+ TREE
Average Block Density                         : 86.66667
Average Sparse Density                        : 78.73684
Block Compression Ratio                       : 0.8897778

See also

GETDBACTIVE
GETDBINFO
GETDBSTATE

GETDEFAULTCALC

The GETDEFAULTCALC command returns the default calc script of the currently selected database.

Syntax

GETDEFAULTCALC

Description

The default calc script refers to either the relations defined in the database outline (CALC ALL) or to the set of calc strings defined as the default database calculation. This command returns the name of the default calc script.

Example

GETDEFAULTCALC;

Default Calc Script --
CALC ALL;

GETMBRCALC

The GETMBRCALC command returns the calc string associated with the selected member.

Syntax

GETMBRCALC mbrName

Description

This command returns the member calc string.

Example

GETMBRCALC "Profit %";

Returns the following:

Outline Defined Calc Equation. [Profit % Sales;]
    Last Calculated Calc Equation. [Profit % Sales;]

GETMBRINFO

The GETMBRINFO command returns information on a specific member.

Syntax

GETMBRINFO mbrName

Description

This command returns the following information on a specific member:

• Member name.
• Member number.
• Dimension name.
• Dimension number.
• Data-storage share information.
• Level: Steps from bottom to top.
• Generation: Steps from top to bottom.
• Unary operator (+, -, *,/,%,~) for consolidation: add, subtract, multiply, divide, percentile, ignore.
• Member tag types, if any; for example, Accounts and Time Series tags, Two-Pass Calc tags.
• Name of the tagged currency database member (if any).
• Currency conversion. Values: Yes/No
• Member description.
• Parent member name.
• Child member name.
• Previous member name.
• Next member name.
• Attributed: Whether the member has attributes associated with it. Values: Yes, No, N/A (N/A for attribute members).
• Attribute Type: The attribute member type. Values: Boolean, Date, Numeric, Text.
• Attribute Value: The short attribute member name, if an attribute member. This is the name shown in the Outline Editor.

Example

GETMBRINFO "Ounces_20";

Returns:

Member info of [ounces_20]
------------------------------------
MbrName      : Ounces_20
MbrNumber    : 2
DimName      : Ounces
DimNumber    : 8
Status       : Virtual Member (Non-stored)
Level        : 0
Generation   : 2
UnaryCalc    : NoRollUp
MbrTagType   : SkipNone
CrMbrName    : N/A
CurrConvert  : N/A
Description  : N/A
ParentMbrName: Ounces
ChildMbrName : N/A
PrevMbrName  : Ounces_32
NextMbrName  : Ounces_16
Attributed   : N/A
Attribute Type    : Numeric(Double)
Attribute Value   : 20

GETMEMBERS

The GETMEMBERS command returns a list of members from the currently selected database.

Syntax

GETMEMBERS [mbrString]

Description

This command returns a list of members from the currently selected database.

Example

To return a list of the database dimension names:

GETMEMBERS ;

To return a list of the children of Product:

GETMEMBERS "Product";

To return a list of the children of Qtr1:

GETMEMBERS "Qtr1";

GETPARTITIONOTLCHANGES

The GETPARTITIONOTLCHANGES command retrieves a list of outline changes made to the partitioned area in the source database, and writes these changes to the .CHG file on the target database you select with the SELECT command.

Syntax

NOTE: All arguments must be provided on one line.

GETPARTITIONOTLCHANGES sourceServerName sourceAppName 
sourceDbName sourcePartitionType getAllOtlChanges 
[
getAllDimChanges 
[getNewDim getDeletedDim getUpdatedDim getMovedDim 
getRenamedDim] 
getAllMbrChanges 
[getNewMbrs getDeletedMbrs 
getRenamedMbrs getMovedMbrs] 
getAllMbrAttribChanges
[getChngedMbrStatus getChngedMbrAlias getChngedMbrCalcSym 
getChngedMbrAcctType getChngedMbrCurrCnvInfo 
getChngedMbrUda getChngedMbrCalcFormulas] 
getChangedLevNbr 
getChangedGenNbr
]

Description

This command retrieves a list of all outline changes made to the data source database, based on the selected parameters, and writes the changes to a .CHG log file on the selected data target database. Hyperion Essbase creates the .CHG file, and names it with a file name representing the partition ID.

Example

With Optional Parameters:

GETPARTITIONOTLCHANGES "BAMBOO" "SAMPLE" "BASIC" 
1 "N" "Y" "Y" "Y" "N" "Y" "Y" "N" "Y" "Y" "N" "Y" "N" "Y" "Y" "Y" "Y" "N" "Y" "Y" "Y" "Y"; 

Without Optional Parameters:

GETPARTITIONOTLCHANGES "BAMBOO" "SAMPLE" "BASIC" 
1 "N" "Y" "Y" "Y" "Y";

See also

APPLYOTLCHANGEFILE

GETUPDATEDREPLCELLS

The GETUPDATEDREPLCELLS command replicates all changed data cells in the replicated partition from a data source database to the selected data target database. Use this command when you are in the data target database.

Syntax

1. GETUPDATEDREPLCELLS sourceServerName sourceAppName sourceDbName
2. GETUPDATEDREPLCELLS ALL

Description

This command gets all changed replicated data cells from the data source server, application, and database, and replicates them in the data target database you select with the SELECT command.

Hyperion Essbase determines what updates are performed, based on an internal time stamp which is read at the block level. Whenever data in the block changes, the time stamp is reset to the current time. If data is changed that is not defined in the replication area, but is part of the data block, the time stamp is still refreshed. Therefore, it is possible to update data in the replication area, even though the replication data has not changed.

When a block is removed by such actions as RESETDB and you request an update of the replication cells, Hyperion Essbase performs an internal search that identifies blocks without time stamps. Hyperion Essbase then gets all cells from the replication area, instead of only changed cells, which may cause a time delay.

GETUPDATEDREPLCELLS gets cells from the data source server to the data target server, based on a request made from the data target server; PUTUPDATEDREPLCELLS puts cells from the data source server to the data target server, based on a request made from the data source server.

Example

GETUPDATEDREPLCELLS "Aspen" "Sample" "Basic";

See also

PUTUPDATEDREPLCELLS
GETALLREPLCELLS

GETUSERINFO

The GETUSERINFO command returns information about a specified user or group.

Syntax

GETUSERINFO userName

Description

This command returns the following information about a specified user or group:
User/Group name, Logged in (Y/N), Access Level, Last successful login, failed login attempts since then, Login ID.

Example

GETUSERINFO "TomT";

GETVERSION

The GETVERSION command returns the version number and patch number information on the current Hyperion Essbase server software installation.

Syntax

GETVERSION

Description

This command returns the version number and patch number for the current server software installation.

Example

GETVERSION;

GOTO

The GOTO command skips all commands until it encounters the associated label.

Syntax

GOTO "Label"; <SKIPPED COMMANDS> :Label ; <COMMANDS OR EOF>

Description

This command provides unconditional branching. This means that branching occurs regardless of the success or failure of previous commands.

Commands that follow :Label can implement error handling or stop processing. Processing skips all subsequent commands and moves to the associated label, where it resumes. Processing ignores even the EXIT command if it precedes :Label.

If EOF occurs before :Label is found, processing terminates.

Example

BUILDDIM 2 "NEWGENS.RUL" 2 "NEWGENS.TXT" 4 "REJREC.ERR";
    GOTO "NEWTARGET";          /* Forced branch */
    LOADDATA 2 "JANACT.TXT";     /* Skip LOADDATA */
    :NEWTARGET;                /* Move here */
    EXIT;                      /* and exit */

HELP

The HELP command provides a list of all available commands.

Syntax

HELP ?

Description

If you enter "?", you see a list of all ESSCMD supported commands.

Example

To see a list of all available commands:

HELP ?;

IFERROR

The IFERROR command checks the status returned by a command and either continues processing or branches to the associated label in response to the status.

Syntax

IFERROR "Label"; <SKIPPED COMMANDS> :Label ; <COMMANDS OR EOF>

Description

This command provides the functionality of error checking and conditional branching on errors.

If the previously executed command returned a nonzero status, processing skips all subsequent commands and moves to the associated label, where it resumes. Commands that follow :Label can implement error handling or stop processing.

Processing ignores even the EXIT command if it precedes :Label. If EOF occurs before :Label is found, processing terminates.

Example

LOGIN "IRIS" "SYS" "PASSWORD";
    SELECT "DANI" "TEST";
    BUILDDIM 2 "NEWGENS.RUL" 2 "NEWGENS.TXT" 4 "REJREC.ERR";
    IFERROR "DIMBUILDFAILED";  /* If BUILDDIM fails */
    LOADDATA 2 "JANACT.TXT";    /* Skip LOADDATA */
    :DIMBUILDFAILED;            /* Move here */
    EXIT;                       /* and exit */

IMPORT

The IMPORT command loads data values from an external source into the currently selected database.

Syntax

IMPORT numeric dataFile fileType y/n ruleLoc rulobjName y/n [ErrorFile]

For an SQL data source, the syntax is as follows:

IMPORT 4 SQLUserName SQLUserPassword Ruleloc rulobjName y/n [ErrorFile]

Description

For information on importing data values, see the Database Administrator's Guide.

Example

IMPORT 2 "ACTUALS" 4 "Y" 2 "ACTUALS" "Y";

INCBUILDDIM

Use the INCBUILDDIM command to incrementally build one or more dimensions from a data file, without restructuring the database. This command provides better performance than BUILDDIM whenever you need to do multiple dimension builds from multiple rules files and your database contains data.

Syntax

INCBUILDDIM location rulobjName dataLoc sourceName fileType errorLog appendLog

Description

This command changes dimensions in the .OTN file according to the specific rules and data files. See BEGININCBUILDDIM for information on the .OTN file.

Each rules file can build one or more dimensions. If one of your rules files builds multiple dimensions and an error occurs in a record for any given dimension, Hyperion Essbase rejects the entire record. Therefore, other dimensions represented in that record might not build correctly. In this case, you need to consider designing your dimension builds with multiple rules files using INCBUILDDIM.

One common example of this problem relates to the Add as Child build method. You should break your rules file into multiple rules files if both of the following circumstances apply:

• Your rules and data files specify more than one Add as Child member per record.
• One of the members being added already exists in the outline as a child of any other parent.

For example, if you are adding Mbr1 and Mbr2 as children of Par1 and Par2:

Par1    Par2
    Mbr1    Mbr2

And if Mbr1 already exists in the outline as the child of some other parent than Par1, you need to break the rules file into two separate builds. Otherwise, when Hyperion Essbase sees that the member already exists in the outline, it rejects the entire record.

This command is identical to the BUILDDIM command, except for the following:

• INCBUILDDIM does not automatically restructure the database after modifying the dimensions. You can have several consecutive INCBUILDDIM commands inside a BEGININCBUILDDIM...ENDINCBUILDDIM block. Hyperion Essbase restructures when it encounters ENDINCBUILDDIM.
• INCBUILDDIM allows you to append to, rather than overwrite, the error log.

Example

To build the dimensions specified in GENREF.RUL and LEVELMUL.RUL, discard all data, and save the new outline after the dimension builds are complete:

BEGININCBUILDDIM;
    INCBUILDDIM 2 "GENREF.RUL" 2 "GENREF.TXT" 4 "ERR.OUT" 1;
    INCBUILDDIM 2 "LEVELMUL.RUL" 2 "LEVELMUL.TXT" 4 "ERR.OUT" 1;
    ENDINCBUILDDIM 4;

Note that you can use the same rules file with multiple data files, as long as the data files conform to the formatting and rules saved in the rules file. For example:

BEGININCBUILDDIM
    INCBUILDDIM 2 "GENREF.RUL" 2 "GENREF1.TXT" 4 "ERR.OUT" 2;
    INCBUILDDIM 2 "GENREF.RUL" 2 "GENREF2.TXT" 4 "ERR.OUT" 1;
    INCBUILDDIM 2 "GENREF.RUL" 2 "GENREF3.TXT" 4 "ERR.OUT" 1;
    ENDINCBUILDDIM 4;

See also

BUILDDIM
BEGININCBUILDDIM
ENDINCBUILDDIM

LISTALIASES

The LISTALIASES command returns a list of alias tables that are defined for the currently selected database.

Syntax

LISTALIASES

Description

This command returns a list of alias tables that are defined for the currently selected database.

Example

LISTALIASES;

LISTAPP

The LISTAPP command returns a list of applications that are defined on the server.

Syntax

LISTAPP

Description

This command returns the applications that are defined on the server.

Example

LISTAPP;

LISTDB

The LISTDB command returns a list of databases that are contained within the currently selected application.

Syntax

LISTDB

Description

This command returns the databases that are contained within the currently selected application.

Example

LISTDB;

LISTFILES

The LISTFILES command helps track the amount of disk space used by Hyperion Essbase databases, by supplying accurate index and data file information.

Syntax

LISTFILES fileType appName dbName

fileType	Type of file for which to display information. Values: Index files. Data files. Index and data files. This is the default.
appname	Name of the application for which information is requested. Required only if no application is selected.
dbname	Name of the database for which information is requested. Required only if no database is selected.

Description

This command provides index and data file names, counts, sizes, and totals, and indicates whether or not each file is presently opened by Hyperion Essbase. The file size information provided by LISTFILES is accurate. Note that the file size information provided by the Windows NT operating system for index and data files that reside on NTFS volumes may not be accurate.

Example

LISTFILES;

----- Index File Information -----

Index File Count:      1

File 1:
   File Name:          C:\HYPERION\ESSBASE\APP\Sample\Basic\ess00001.ind
   File Type:          INDEX
   File Number:        1 of 1
   File Size:          8,024 KB (8,216,576 bytes)
   File Opened:        Y

Index File Size Total: 8,024 KB (8,216,576 bytes)

----- Data File  Information -----

Data  File Count:      1

File 1:
   File Name:          C:\HYPERION\ESSBASE\APP\Sample\Basic\ess00001.pag
   File Type:          DATA
   File Number:        1 of 1
   File Size:          8,008 KB (8,200,192 bytes)
   File Opened:        Y

Data File Size  Total: 8,008 KB (8,200,192 bytes)

File Size Grand Total: 16,032 KB (16,416,768 bytes)

LISTFILTERS

The LISTFILTERS command lists the filters in a database.

Syntax

LISTFILTERS appName dbName

Description

This command lists the filters in a database.

Example

LISTFILTERS "FINANC95" "SALES95";

LISTGROUPS

The LISTGROUPS command returns a list of groups that are defined on the server.

Syntax

LISTGROUPS

Description

This command is used to classify users with identical security requirements.

Example

LISTGROUPS;

LISTGROUPUSERS

The LISTGROUPUSERS command returns a list of users that belong to a specified group.

Syntax

LISTGROUPUSERS groupName

Description

This command is used to classify users with identical security requirements.

Example

To return a list of all users that belong to the group called MARKETING:

LISTGROUPUSERS "MARKETING";

LISTLINKEDOBJECTS

The LISTLINKEDOBJECTS command lists information about the objects linked to the active database for a given user name or modification date.

Syntax

LISTLINKEDOBJECTS userName modDate

Description

This command lists information about linked objects, including the object type, name, and description, based on criteria you specify. If you specify both a user name and modification date, objects matching both criteria are listed. If you specify no user name or date, a list of all linked objects in the database appears.

You must select a database before using LISTLINKEDOBJECTS.

For more information on linked objects, see the Database Administrator's Guide.

Example

To list all objects last modified by user Diana on or before July 7, 1997:

LISTLINKEDOBJECTS "Diana" "07/07/1997";

LISTLOCATIONS

The LISTLOCATIONS command displays all location aliases defined on the current database.

Syntax

LISTLOCATIONS

Description

This command displays the location alias parameters as defined and created with the CREATELOCATION command. You must have Database Designer privilege to list location aliases.

Example

LISTLOCATIONS;

Location Alias  Server      Application    Database     Username
--------------- ----------- -------------- ------------ ---------------
Alias4          Seashell    Sample         Interntl     admin
Alias3          Aspen       Demo           Basic        user1
Alias2          Aspen       Samppart       Company      partitionuser
Alias1          Aspen       Sample         Basic        Admin

See also

CREATELOCATION
DELETELOCATION

LISTLOGINS

The LISTLOGINS command returns the list of login instances in your session.

Syntax

LISTLOGINS

Description

This command returns the list of login instances in your session.

Example

LISTLOGINS;

LISTLOCKS

The LISTLOCKS command returns a list of all users who have locks on blocks for the currently selected database.

Syntax

LISTLOCKS [appName dbName]

Description

This command returns a list of all users who have locks on blocks for the currently selected database.

Example

LISTLOCKS;

LISTOBJECTS

The LISTOBJECTS command returns a list of objects.

Syntax

LISTOBJECTS number appName dbName

Description

The list of objects returned by this command includes object names and the status of object locks.

Two values for the objType parameter, 6 and 7, are retained only for backward compatibility with Release 2.0.

Option 11, Linked Reporting Object, lists only stored LROs; that is, files with the .LRO extension. It does not list URLs, cell notes, or linked partitions. Use the LISTLINKEDOBJECTS command to list these objects.

Example

To return a list of outline objects associated with the BASIC database:

LISTOBJECTS 1 "SAMPLE" "BASIC";

LISTUSERS

The LISTUSERS command returns a list of the users that are defined on the server.

Syntax

LISTUSERS

Description

This command returns a list of the users that are defined on the server.

Example

LISTUSERS;

LISTVARIABLES

The LISTVARIABLES command lists all substitution variables defined for a specified server.

Syntax

LISTVARIABLES serverName [appName [dbName]]

Description

This command lists all existing substitution variables and their corresponding values for a specified server, application, or database.

Example

LISTVARIABLES "Bamboo" "Sample" "Basic";

LOADALIAS

The LOADALIAS command loads an alias table to the currently selected database.

Syntax

LOADALIAS aliasName fileName

Description

Refer to the Database Administrator's Guide for more information about alias tables in a database.

Example

To load the contents of LONGDESC.ALT into the alias table called LONG NAMES:

LOADALIAS "LONG NAMES" "c:\hyperion\essbase\app\sample\basic\longdesc.alt";

LOADAPP

The LOADAPP command is used to load an application and its respective databases into memory.

Syntax

LOADAPP appName

Description

Loads an application and databases into memory. In order for users to access information in databases, the application or individual database must be loaded.

Example

To load an application called Sample into memory on the server:

LOADAPP "Sample";

LOADDATA

The LOADDATA command loads data without a rules file.

Syntax

LOADDATA numeric fileName

Description

Loads data without a rules file. The value you enter for the numeric parameter tells Hyperion Essbase where fileName resides.

Example

LOADDATA 2 "calcdat";

LOADDB

The LOADDB command loads a database into memory.

Syntax

LOADDB appName dbName

Description

Loads a database into memory. A database must be loaded in order for users to access its information.

Example

To load a database called BASIC from an application called SAMPLE:

LOADDB "SAMPLE" "BASIC";

LOGIN

The LOGIN command is used to log in to the server.

Syntax

LOGIN hostNode userName password [appName] [dbName]

Description

The server must already be running before a login can occur.

If you want to use the optional appName and dbName parameters, you must use both.

With the optional parameters, this command is the equivalent of logging in and issuing a SELECT appName and dbName command.

Example

To logs a user named TomT who is using ESSCMD from the server:

LOGIN "LOCAL" "TomT" "PASSWORD";

To log in a user named TomT to a server named BEECH:

LOGIN "BEECH" "TomT" "PASSWORD";

LOGOUT

The LOGOUT command is used to log out of the server.

Syntax

LOGOUT

Description

This command logs you out of the server, but does not exit the ESSCMD session.

Example

LOGOUT;

LOGOUTALLUSERS

The LOGOUTALLUSERS command logs out all users from the Hyperion Essbase server.

Syntax

LOGOUTALLUSERS Y/N

Description

Use this command to log out all users from the Hyperion Essbase server. This command logs out all users, except the user issuing the command.

Example

LOGOUTALLUSERS "Y";

See also

LOGOUTUSER

LOGOUTUSER

The LOGOUTUSER command logs a specific user off the server.

Syntax

LOGOUTUSER userNumber

Description

This command is available in interactive mode only.

To find the user number, issue this command without a parameter. ESSCMD displays a list of logged-in users with numbers representing their login order. You can select the user to log off.

Example

To log the user whose user number is 1 off the server:

LOGOUTUSER 1;

See also

LOGOUTALLUSERS

OUTPUT

The OUTPUT command directs process information output from the ESSCMD session to a text file.

Syntax

OUTPUT outputType [outputName/errorName]

Description

Messages from the ESSCMD session are sent to a file instead of to the screen.

Example

To write statistics tables returned from the GETPERFSTATS command to an ASCII file called "stats":

OUTPUT 1 "stats";  :Send process info from ESSCMD to file "stats"
GETPERFSTATS;      :Execute this command
OUTPUT 3 "stats";  :Stop sending process info to file "stats"

To write errors during the session to a file called CMDERR:

OUTPUT 2 "CMDERR";

To writes statistics to the output file STATINFO:

OUTPUT 1 "STATINFO";

To write only the information that the calculation ran, and not all messages:

OUTPUT 1 "CALCDEFAULT";

PAREXPORT

The PAREXPORT command starts the parallel export process.

Syntax

PAREXPORT [-threads n] [-in] input_filename\output_filename amount formatOption

Description

Parallel export may create multiple export files based on the number of export threads specified. The database is divided as evenly as possible among the number of parallel export threads.

Example

PAREXPORT -threads 4 -in e:\data\input.txt 1 1;

Note:	e:\data\input.txt is an ASCII file that contains at least four filenames on separate lines; that is:
	e:\data\export1.txt e:\data\export2.txt d:\data\export3.txt d:\data\export4.txt

PRINTPARTITIONDEFFILE

The PRINTPARTITIONDEFFILE command produces an ASCII text file of the partition-mapping tables of the distributed database.

Syntax

PRINTPARTITIONDEFFILE location [ddbFileName] textFileName

Description

The ASCII text file contains the following information for each partition:

• Total number of partitions
• Partition server, application, database, and user
• Time the partition was last modified
• Partition definition
• Connection information
• Partition shape definition
• Partition type information
• Database map information
• Slice map information
• Region identification
• Outline change direction

Example

PRINTPARTITIONDEFFILE 2 "basic.ddb" "basic.txt";

PURGELINKEDOBJECTS

The PURGELINKEDOBJECTS command deletes objects linked to the active database for a given user name or modification date.

Syntax

PURGELINKEDOBJECTS userName modDate

Description

This command deletes linked objects based on criteria you specify. A list of the objects matching your criteria appears as they are being deleted. If you specify both a user name and modification date, objects matching both criteria are deleted. If you specify no user name or date, all linked objects in the database are deleted.

You must select a database before using PURGELINKEDOBJECTS. You must also have design privilege for the database to delete any objects.

For more information on linked objects, see the Database Administrator's Guide.

Example

To delete all objects last modified by user Diana on or before July 7, 1997:

PURGELINKEDOBJECTS "Diana" "07/07/1997";

PURGEOTLCHANGEFILE

The PURGEOTLCHANGEFILE command deletes outline changes that already have been applied from the .CHG log file.

Syntax

PURGEOTLCHANGEFILE serverName appName dbName partitionType direction

Description

This command deletes any outline changes that have already been applied from the .CHG file for the selected database, based on parameters that you supply.

Example

PURGEOTLCHANGEFILE "BAMBOO" "Sample" "Basic" 1 "Source";

PUTALLREPLCELLS

The PUTALLREPLCELLS command replicates all data cells in a replicated partition from the data source database you selected with the SELECT command, to a specified data target database. Use this command when you are in the data source database.

Syntax

1: PUTALLREPLCELLS targetServerName targetAppName targetDbName
2: PUTALLREPLCELLS ALL

Description

This command puts all replicated data cells from the selected data source server, application, and database, and replicates them to the data target database. This is useful when the data in the source and target databases are out of synch and need to be resynchronized.

PUTALLREPLCELLS puts cells from the data source server to the data target server, based on a request made from the data source server; GETALLREPLCELLS gets cells from the data source server to the data target server, based on a request made from the data target server.

Example

PUTALLREPLCELLS "Aspen" "Sample" "Basic";

See also

GETALLREPLCELLS
PUTUPDATEDREPLCELLS

PUTUPDATEDREPLCELLS

The PUTUPDATEDREPLCELLS command replicates all changed data cells in the replicated partition from the data source database you selected with the SELECT command, to the specified data target database. Use this command when you are in the data source database.

Syntax

1: PUTUPDATEDREPLCELLS targetServerName targetAppName targetDbName
2: PUTUPDATEDREPLCELLS ALL

Description

This command takes all changed replicated data cells from the selected data source server, application, and database, and replicates them in the data target database.

Hyperion Essbase determines what updates are performed based on an internal time stamp which is read at the block level. Whenever data in the block changes, Essbase updates the time stamp to the current time. If data is changed that is not defined in the replication area, but is part of the data block, the time stamp is still reset. Therefore, it is possible to update data in the replication area, even though the replicated data has not changed.

When a block is removed by such actions as RESETDB, and you request an update of the replication cells, Hyperion Essbase performs an internal search that identifies blocks without time stamps. Hyperion Essbase then gets all cells from the replication area, instead of only changed cells. This may take some time, depending on the size of the block.

PUTUPDATEDREPLCELLS puts cells from the data source server to the data target server, based on a request made from the data source server; GETUPDATEDREPLCELLS gets cells from the data source server to the data target server, based on a request made from the data target server.

Example

PUTUPDATEDREPLCELLS "Aspen" "Sample" "Basic";

See also

GETUPDATEDREPLCELLS
PUTALLREPLCELLS

REMOVEUSER

The REMOVEUSER command removes a user from a group.

Syntax

REMOVEUSER groupName userName

Description

Groups are used to classify users with identical security requirements.

Example

To remove the user DANTE from the group called INTERNTL:

REMOVEUSER "INTERNTL" "DANTE";

REMOVELOCKS

The REMOVELOCKS command removes any locks that a specified user has acquired through a spreadsheet operation.

Syntax

REMOVELOCKS userNumber

Description

Removing locks is sometimes required for maintenance-related activities.

Example

To remove all locks that are held by user number 1 on the currently selected database:

REMOVELOCKS 1;

RENAMEAPP

The RENAMEAPP command renames an existing application.

Syntax

RENAMEAPP sourceApp newAppName

Description

This command renames an existing application.

Example

RENAMEAPP "FINANC95" "ANNFIN95";

RENAMEDB

The RENAMEDB command renames an existing database.

Syntax

RENAMEDB sourceApp sourceDb newDbName

Description

This command renames an existing database.

Example

RENAMEDB "FINANC95" "SALES95" "95SALES";

RENAMEFILTER

The RENAMEFILTER command renames an existing filter.

Syntax

RENAMEFILTER sourceApp sourceDb sourceFltr newFltrName

Description

This command renames an existing filter.

Example

RENAMEFILTER "FINANC95" "SALES95" "FILTER95" "95FILT";

RENAMEOBJECT

The RENAMEOBJECT command renames an existing object.

Syntax

RENAMEOBJECT objType sourceApp sourceDb sourceObj newObjName

Description

Two values for the objType parameter, 6 and 7, are retained only for backward compatibility with Release 2.0.

Example

RENAMEOBJECT 2 "FINANC95" "SALES95" "OLDOBJ" "ARCHIVE";

RENAMEUSER

The RENAMEUSER command renames an existing user.

Syntax

RENAMEUSER userName newUserName

Description

To rename a user, you must have Supervisor or other appropriate security privileges.

Example

RENAMEUSER "NEWUSER" "D_ROSETTI";

REPORT

The REPORT command is used to execute one or more report strings.

Syntax

REPORT reportString

Description

This command should end with a blank string.

Example

To create a report based on all descendants of Year, including the Year member:

REPORT "<IDESC YEAR" ! ;

See also

REPORTLINE

REPORTLINE

The REPORTLINE command is used to execute a single report string.

Syntax

REPORTLINE reportString

Description

This command is used to execute a single report string.

Example

To create a report based on all descendants of Year:

REPORTLINE "<DESC YEAR !";

See also

REPORT

RESETDB

The RESETDB command clears all the data from the currently selected database.

Syntax

RESETDB

Description

This command is used to clear all the data from the currently selected database.

Example

RESETDB;

RESETOTLCHANGETIME

The RESETOTLCHANGETIME command changes the time on the server you selected with the SELECT command, to match the time on another server.

Syntax

RESETOTLCHANGETIME fromPartition toPartition

fromPartition includes the following parameters:

toPartition includes the following parameters:

Description

This command synchronizes the internal time stamps between two servers containing partitions. This time stamp is used when performing GETPARTITIONOTLCHANGES and APPLYOTLCHANGEFILE operations.

When you use GETPARTITIONOTLCHANGES, the time is stamped in the data target partition's Change log file (.CHG). When you use APPLYOTLCHANGEFILE, the time in the .CHG file is read, and stamped TO the data target partition's partition mapping definition (.DDB) file.

For more information, see the Database Administrator's Guide.

Example

RESETOTLCHANGETIME "BAMBOO" "SAMPLE" "BASIC" 1 
    "SOURCE" "ASPEN" "SAMPLE" "BASIC" 1 "TARGET";

See also

GETPARTITIONOTLCHANGES
APPLYOTLCHANGEFILE

RESETSTATUS

The RESETSTATUS command resets all saved status values to 0 (zero).

Syntax

RESETSTATUS

Description

This command is used in ESSCMD error handling.

RESETSTATUS resets:

• All saved status values, including that of the previous command.
• The returned status values, as tested in IFERROR.

Example

RESETSTATUS;

RESTORE

The RESTORE command is no longer used, and is retained for backward compatibility. When you run the RESTORE command, Hyperion Essbase returns an informational message.

See also

BEGINARCHIVE
ENDARCHIVE

RUNCALC

The RUNCALC command runs a calc script.

Syntax

RUNCALC numeric calcScript

Description

The value you enter for the numeric parameter tells Hyperion Essbase where calcScript resides.

Example

To execute a calc script object on the server called FAM100:

RUNCALC 2 "FAM100";

RUNREPT

The RUNREPT command runs a report script.

Syntax

RUNREPT numeric reptScript outputFile

Description

The value you enter for the numeric parameter tells Essbase where reportScript resides. Use the OUTPUT command to suppress the onscreen display of the script.

Example

To execute a report script called P&L on the server:

RUNREPT 2 "P&L" "P&L.out";

SELECT

The SELECT command is used to select an application and database.

Syntax

SELECT appName dbName

Description

This command selects the application and database on which to focus subsequent commands.

Example

To select the database called BASIC in the application called SAMPLE:

SELECT "SAMPLE" "BASIC";

SETALIAS

The SETALIAS command sets an alias table as the primary table.

Syntax

SETALIAS aliasName

Description

Example

SETALIAS "Long Names";

SETAPPSTATE

The SETAPPSTATE command defines application settings.

Syntax

SETAPPSTATE ["appName"] "desc" Y/N Y/N accessLevel
Y/N Y/N Y/N Y/N lockTimeout MaxLROFileSize;

Description

Using the semicolon statement terminator (;) is optional in ESSCMD batch files. However, it is good practice to use the terminator with this command to signal the end of the parameter list. This is especially important if you omit some of the parameters and take their default values. If not all parameters are present, and the ; is omitted, ESSCMD looks for the remaining values in the next statement in the batch file, leading to unpredictable results.

As with many other ESSCMD commands, if you issue only the SETAPPSTATE keyword in interactive mode, ESSCMD prompts you for the other values.

Example

SETAPPSTATE "sample" "The application is ready"
    "Y" "Y" 0 "Y" "Y" "Y" "Y" "3600";

SETDBSTATE

The SETDBSTATE command defines database settings. For more options, see SETDBSTATEITEM.

Syntax

SETDBSTATE ["appName"] ["dbName"] "desc" Y/N Y/N accessLevel
dataCacheSize Y/N Y/N Y/N currDb ccType 0/1 indexCacheSize
IndexPageSize Y/N;

Note: It is most efficient to load the required database before you run the SETDBSTATE command, then stop and restart the database for the command to take effect.

Description

Using the semicolon statement terminator (;) is optional in ESSCMD batch files. However, it is good practice to use the terminator with this command to signal the end of the parameter list. This is especially important if you omit some of the parameters and take their default values. If not all parameters are present, and the ; is omitted, ESSCMD looks for the remaining values in the next statement in the batch file, leading to unpredictable results.

As with many other ESSCMD commands, if you issue only the SETDBSTATE keyword in interactive mode, ESSCMD prompts you for the other values.

Note: Load the required database before you run the SETDBSTATE command, then stop and restart the database for this command to take effect.

Example

SETDBSTATE "Data has been updated" "Y" "Y" 4 "3000000"
    "N" "Y" "N" "" "" 0 "1049000" "1024" "Y";

SETDBSTATEITEM

The SETDBSTATEITEM command defines database settings by number, and provides more options than SETDBSTATE.

Syntax

SETDBSTATEITEM [optionNumber] ["appName"] ["dbName"] ["values"]

Note: It is most efficient to load the required database before you run the SETDBSTATE command, then stop and restart the database for the command to take effect.

Description

The SETDBSTATEITEM command defines database settings by number, and provides more options than SETDBSTATE.

Enter:
SETDBSTATEITEM optionNumber ["application name"] ["database name"] ["values"]

optionNumber is a number between 0 and 99, corresponding to the itemized descriptions above. Values depend on the option you select. As with many other ESSCMD commands, if you issue only the SETDBSTATEITEM keyword in interactive mode, ESSCMD displays a list of all options. In interactive mode, you do not need to supply any values on the command line; ESSCMD prompts you for the required values.

Using the semicolon statement terminator (;) is optional in ESSCMD batch files. However, it is good practice to use the terminator with this command to signal the end of the parameter list. This is especially important if you omit some of the parameters and take their default values. If not all parameters are present, and the ; is omitted, ESSCMD looks for the remaining values in the next statement in the batch file, leading to unpredictable results.

Notes:

• Items 14 and 15 (Data Compression and Data Compression Type) are effective as soon as Hyperion Essbase writes blocks to disk. This command has no effect on blocks already on disk until the next time Hyperion Essbase writes them.
• Items 18, 19, and 20 (Isolation level, Pre-Image Access, and Time Out) are effective the next time there are no active transactions in the database.
• Items 5, 12, 21, and 22 (Data Cache Size, Index Cache Size, Blocks Modified Before Internal Commits, and Rows to Data Load Before Internal Commit) are effective when the database is stopped and re-started.
• Item 13, Index Page Size, takes effect when the database is reset and re-started.

Examples

The following example enables Committed access and Pre-image access, and specifies indefinite wait time:

SETDBSTATEITEM 18 "JTEMP" "JTEMPDB" "1" "Y" "1";

The following example allocates up to 4 gigabytes on Volume E, sets a maximum file size of 1 gigabyte, and specifies that data files should be stored only on E:

SETDBSTATEITEM 23 "SAMPLE" "BASIC" "1" "E" "4G" "2" "1G"

SETDEFAULTCALC

The SETDEFAULTCALC command sets a calculation string as the default database calculation.

Syntax

SETDEFAULTCALC calcString

Description

Place the default database calculation within quotation marks. Calculation strings require the ending semicolon.

Example

SETDEFAULTCALC "CALC ALL;";

SETDEFAULTCALCFILE

The SETDEFAULTCALCFILE command sets a calculation object as the default database calculation.

Syntax

SETDEFAULTCALCFILE calcobjName

Description

This command sets a calculation object as the default database calculation.

Example

SETDEFAULT "actbud";

SETHELP

The SETHELP command changes the number of lines of command-listing output the ESSCMD HELP command displays on the screen at a time.

Syntax

SETHELP numberLines

Description

This command changes the number of lines of command-listing output the ESSCMD HELP command displays on the screen at a time.

Example

To set the display of commands listed to 10 lines:

SETHELP "10";

SETLOGIN

The SETLOGIN command sets the active login to a particular instance.

Syntax

SETLOGIN sesNo

Description

This command provides a list of login instances. To get session numbers, use the LISTLOGINS command.

Example

To set the ESSCMD session to login the previous login instance:

SETLOGIN PREV;

To set the ESSCMD session to login the next login instance:

SETLOGIN NEXT

To set the ESSCMD session to login instance number 2:

SETLOGIN 2

SETMSGLEVEL

The SETMSGLEVEL command defines the level of messages that are generated by the server.

Syntax

SETMSGLEVEL level

Description

This command defines the level of messages that are generated by the server.

Example

SETMSGLEVEL 3;

SETPASSWORD

The SETPASSWORD command assigns a new password to an existing user.

Syntax

SETPASSWORD userName newPassword

Description

This command assigns a new password to an existing user.

Example

SETPASSWORD "D_ROSETTI" "INFERNO";

SHUTDOWNSERVER

The SHUTDOWNSERVER command lets you shut down the Agent from any terminal connected to it. You must have Supervisor privilege to use this command.

Syntax

SHUTDOWNSERVER servername username password

Description

This command lets you shut down the Hyperion Essbase Agent from any terminal connected to it. You must have Supervisor privilege to use this command.

If you do not specify the parameters on SHUTDOWNSERVER, Hyperion Essbase prompts you for them.

Examples

To shut down a server from an ESSCMD batch script, enter the following command in the batch script:

SHUTDOWNSERVER "servername" "username" "password"

To shut down the Hyperion Essbase server Poplar:

SHUTDOWNSERVER "poplar" "mildred" "password";

To have Hyperion Essbase prompt you for your user name and password:

SHUTDOWNSERVER "Poplar";

To shut down the Hyperion Essbase server Poplar, enter the following in a batch script:

SHUTDOWNSERVER "poplar" "mildred" "password";

SLEEP

The SLEEP command pauses an ESSCMD script.

Syntax

SLEEP "seconds"

Description

Pausing an ESSCMD batch file allows other commands to finish execution and cleanup.

Example

SLEEP "10";

UNLOADALIAS

The UNLOADALIAS command unloads the existing alias table.

Syntax

UNLOADALIAS aliasName

Description

This command unloads the existing alias table.

Example

UNLOADALIAS "LONG NAMES";

UNLOADAPP

The UNLOADAPP command unloads an application from memory on the server.

Syntax

UNLOADAPP appName

Description

All databases within the application are unloaded.

Example

UNLOADAPP "SAMPLE";

UNLOADDB

The UNLOADDB command is used to unload a database from memory on the server.

Syntax

UNLOADDB appName dbName

Description

This command is used to unload a database from memory on the server.

Example

UNLOADDB "SAMPLE" "BASIC";

UNLOCKOBJECT

The UNLOCKOBJECT command unlocks an existing object.

Syntax

UNLOCKOBJECT objType sourceApp sourceDb sourceObj

Description

Values 5 through 8 for the objType parameter represent objects that cannot be locked.

Two values for the objType parameter, 6 and 7, are retained only for backward compatibility with Release 2.0.

Option 11, Linked Reporting Object, unlocks stored LROs only; that is, files with the .LRO extension. It does not unlock URLs, cell notes, or linked partitions.

Example

UNLOCKOBJECT 1 "FINANC95" "SALES95" "ARCHIVE";

UPDATE

The UPDATE command loads a single data record.

Syntax

UPDATE dataString

Description

This command loads a single data record.

Example

UPDATE "Year Measures Product Market Scenario 12";

UPDATEFILE

The UPDATEFILE command loads data, unlocks blocks, and verifies a data file.

Syntax

UPDATEFILE location fileName update

Description

This command command loads data, unlocks blocks, and verifies a data file.

Example

UPDATEFILE 2 "DATA" 1;

UPDATEVARIABLE

The UPDATEVARIABLE command updates the variable value that corresponds to the specified substitution variable.

Syntax

UPDATEVARIABLE variableName [serverName [appName [dbName]]] value

Description

This command updates the string value of the selected substitution variable.

Example

UPDATEVARIABLE "CurQtr" "Bamboo" "Sample" "Basic" "Qtr2";

VALIDATE

The VALIDATE command checks the database for data integrity.

Syntax

VALIDATE errorlogFile

For example:

ESSBASE\APP\app\db\VALIDATE.LST

This command validates the current database. You must select a database before issuing the VALIDATE command.

The VALIDATE command checks the following information:

• VALIDATE checks for data integrity in each block. Reading from top to bottom, it checks blocks, sections, block type, and block length. The command checks for validity in floating-point numbers. This command writes information about bad blocks to the log file.
• The Hyperion Essbase index contains an entry for every data block. For every Read operation, VALIDATE automatically compares the index key in the index page with the index key in the corresponding data block and checks other header information in the block. If it encounters a mismatch, VALIDATE displays an error message and continues processing until it checks the entire database.
• VALIDATE verifies the structural integrity of the index free space information in the index.
• VALIDATE verifies the structural integrity of the LRO catalog.

If this command finds integrity errors, it writes validation process error messages to a text-format log file. The default location for the specified file is in the application\database directory. For example: ESSBASE\APP\app\db\VALIDATE.LST.

NOTE: You can also use the VALIDATE command to clear an internal file, database_name.OCL, when it grows too large. database_name.OCL is a file used for incremental restructuring. VALIDATE causes Hyperion Essbase to restructure any blocks whose restructure was deferred, and clears the file. When you issue VALIDATE, make sure the database is not in Read-only mode (Read-only mode is used for archiving).

Example

VALIDATE;

VALIDATEPARTITIONDEFFILE

The VALIDATEPARTITIONDEFFILE command validates shared partition definitions.

Syntax

VALIDATEPARTITIONDEFFILE

Description

This command validates the specified partition definition identified in the partition mapping definition .DDB file. During validation, Hyperion Essbase checks the .DDB file to ensure that:

• The area definition is valid (contains no syntax errors).
• The specified data source members are valid members and map to valid members in the data target.
• All connection information is correct (server names, database names, application names, user names, and password information).
• For linked partitions, the specified default user name and password are correct.
• For replicated and transparent partitions:
  • A replication target does not overlap with replication target.
  • A replication target does not overlap with transparent target.
  • A transparent target does not overlap with transparent target.
  • A replication source does not overlap with transparent target.
  • The cell count for the partition is the same on the data source and the data target.

You must issue the VALIDATEPARTITIONDEFFILE command for both the data source and the data target .DDB files. You need to log in to each server and issue the command separately for each portion of the partition definition.

For more information, see the Database Administrator's Guide.

Example

VALIDATEPARTITIONDEFFILE