ESTIMATEFULLDBSIZE |
EXPORT PAREXPORT |
PAREXPORT |
EXPORT GETVERSION |
CREATELOCATION DELETELOCATION GETATTRIBUTESPECS GETATTRINFO GETPERFSTATS LISTFILES LISTLOCATIONS RESETPERFSTATS |
GETDBINFO GETDBSTATE GETMBRINFO SETDBSTATEITEM |
The ADDUSER command adds a user to a group.
ADDUSER groupName userName
groupName | Name of an existing group. |
userName | Name of an existing user. |
Use groups to classify users with identical security requirements.
To add the user TomT to the group named MARKETING:
ADDUSER "Marketing" "TomT";
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.
APPLYOTLCHANGEFILE numFiles fileName
numFiles | A numeric value indicating the number of .CHG log files to read. |
Filename | The name of the .CHG log file to read. The filename must be the full path name of the desired change file on the target database. The filename must be in quotation marks (see example below). More than one file can be specified. |
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.
Samppart Company, the target database, is selected. Apply outline changes from Sampeast East, the source database.
APPLYOTLCHANGEFILE 1 "C:\Hyperion\Essbase\App\Sampeast\East\ess00004.chg";
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.
The BEGINARCHIVE command places a database in Read-only mode for archiving.
BEGINARCHIVE App DB file
App | Name of the application to archive. |
DB | Name of the database to archive. |
file | The file to contain the archive. |
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.
BEGINARCHIVE "Sample" "Sales" "June";
The BEGININCBUILDDIM command prepares Hyperion Essbase for upcoming incremental dimension-building commands.
BEGININCBUILDDIM
This command works in conjunction with the ENDINCBUILDDIM command to group together one or more INCBUILDDIM statements.
This command 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.
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;
ENDINCBUILDDIM
INCBUILDDIM
BUILDDIM
Use the BUILDDIM command to dynamically build one or more dimensions from a data file or SQL source.
BUILDDIM location rulobjName dataLoc sourceName fileType errorLog
Parameter | Description/Values |
location |
Location of the rules object. 1 - Local/client-based rules object. 2 - Remote/server rules object. 3 - File. Use option 3 if the file is not a Hyperion Essbase object, or if you want to specify the full path name. Otherwise, Hyperion Essbase looks in the < APPNAME >/<DBNAME > directory. |
rulobjName | Name of the rules object |
dataLoc | Location of the data file. 1 - Local/client data file. 2 - Remote/server data file. 3 - File. Use option 3 if the file is not a Hyperion Essbase object, or if you want to specify the full path name. Otherwise, Hyperion Essbase looks in the < APPNAME >/<DBNAME > directory.4 - SQL source. |
sourceName | Source of the data file. If dataLoc is 1, 2, or 3, specify the data file name. If dataLoc is 4, specify the SQL user name and password. |
fileType | Data file type. 1 - Excel file. 2 - Lotus .WK1 file. 3 - Lotus .WK3 file. 4 - Text file. 5 - Lotus .WK4 file (this parameter is not required if you are using an SQL source). |
errorLog | Name of the text file to receive error messages and rejected records. |
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:
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";
The CALC command executes one or more calculation strings.
In interactive ESSCMD, you can enter multiple strings, one at a time.
CALC "calcString; [calcString;]"
calcString | A calculation string (any valid string that is accepted by a calculation script). |
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.
To issue the CALC ALL command:
CALC "Calc All;";
To calculate the members January and Product:
CALC "Jan; Product;";
The CALCDEFAULT command calculates the default database calculation.
CALCDEFAULT
It calculates the relationships defined in the outline or a calc string that is set to the default calculation.
CALCDEFAULT;
The CALCLINE command executes a single calculation string.
CALCLINE calcString
calcString | A calculation string (any valid string that is accepted by a calculation script). |
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.
To issue the CALC ALL command:
CALCLINE "Calc All;";
To calculate the members January and Product:
CALCLINE "Jan; Product;";
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.
The COPYAPP command copies an application.
COPYAPP sourceApp destApp
sourceApp | Name of application to copy. |
destApp | Name of application copy. |
This command copies an application.
COPYAPP "FINANC95" "FINANC96";
The COPYDB command copies a database.
COPYDB sourceApp sourceDb destApp destDb
sourceApp | Name of the application that includes the database to copy. |
sourceDb | Name of the database to copy. |
destApp | Name of the application for the new database. |
destDb | Name of the database copy. |
This command copies a database.
COPYDB "FINANC95" "SALES95" "FINANC96" "SALES96";
The COPYFILTER command copies a filter.
COPYFILTER sourceApp sourceDb sourceFilter destApp destDb destFilter
sourceApp | Name of the application that includes the filter to copy. |
sourceDb | Name of the database that includes the filter to copy. |
sourceFilter | Name of the filter to copy. |
destApp | Name of the application for the new filter. |
destDb | Name for the database for the new filter. |
destFilter | Name of the filter copy. |
COPYFILTER "FINANC95" "SALES95" "FILTER95" "FINANC96" "SALES96" "FILTER96";
The COPYOBJECT command copies a database object.
COPYOBJECT objType sourceApp sourceDb sourceObj destApp destDb destObj
Parameter | Description/Values |
objType |
Type of object to list. 0 - Abort 1 - Outline object (not available) 2 - Calculation script 3 - Report script 4 - Rules object 5 - Alias table 6 - Structure file 7 - Backup file (not available) 8 - Worksheet of any type (not available) 9 - Text object 10 - Partition 11 - Linked Reporting Object 12 - Selection 13 - Wizard |
sourceApp | Name of the application that includes the object to copy. |
sourceDb | Name of the database that includes the object to copy. |
sourceObj | Name of the object to copy. |
destApp | Name of the application for the new object. |
destDb | Name of the database for the new object. |
destObj | Name of the object copy. |
Two values for the objType parameter, 6 and 7, are retained only for backward compatibility with Release 2.0.
COPYOBJECT "2" "FINANC95" "SALES95" "OLDOBJ" "FINANC96" "SALES96" "NEWOBJ";
The CREATEAPP command creates a new application.
CREATEAPP appName
appName | Name of the application to create. |
This command creates a new application.
To create an application called TBC:
CREATEAPP "TBC";
The CREATEDB command creates a database.
CREATEDB appName dbName
appName | Name of the application in which to create a database. |
dbName | Name of the database to create. |
You can create a database for any application that already exists on the server.
To create an database called FINANCE under an application named TBC:
CREATEDB "TBC" "FINANCE";
The CREATEGROUP command creates a group.
CREATEGROUP groupName
groupName | Name of the group to create. |
This command creates a new group. Groups classify users with identical security privileges.
To create a group called MARKETING:
CREATEGROUP "MARKETING";
The CREATELOCATION command creates a new location alias at the database level.
CREATELOCATION alias host application database user_name password
alias | Desired location alias name. |
host | Destination host name. |
application | Destination application name. |
database | Destination database name. |
user_name | Login name. |
password | Valid password for user_name. |
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:
CREATELOCATION "ALIAS3" "LOCAL" "SAMPLE" "BASIC" "TomT" "PASSWORD";
The CREATEUSER command creates a new user ID.
CREATEUSER userName password
userName | Name of the user ID to create. |
password | Password for the new user. |
This command creates a new user ID and password.
To create a user named DANTE with the password INFERNO:
CREATEUSER "DANTE" "INFERNO";
The CREATEVARIABLE command defines a new substitution variable and its corresponding string value on the server.
CREATEVARIABLE variableName serverName [appName [dbName]] value
variableName | The name to give to the new substitution variable. The name must be alphanumeric and can contain a maximum of 80 characters. You can use underscores, but not spaces. |
serverName | Name of the server for which the variable is defined. |
appName | Optional. Name of the application for which the variable is defined. |
dbName | Optional. Name of the database for which the variable is defined. |
value | The string value that corresponds to the substitution variable set on the server. The name must be alphanumeric and can contain a maximum of 255 characters. It can include a null value. Do not use the & character as the leading character in the value string. |
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.
CREATEVARIABLE "CurQtr" "Bamboo" "Sample" "Basic" "Qtr1";
The DEFRAG command is no longer used. Starting with Release 5.0, defragmentation of data freespace is performed dynamically by the Hyperion Essbase kernel.
The DELETEAPP command deletes an application.
DELETEAPP appName
appName | Name of the application to delete. |
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.
To delete an application called TBD:
DELETEAPP "TBC";
The DELETEDB command deletes a database.
DELETEDB appName dbName
appName | Name of the application containing the database to delete. |
dbName | Name of the database to delete. |
Deleting a database deletes all of its associated objects, along with any additional files that reside in the database directory.
To delete a database called BASIC from an application called TBC:
DELETEDB "TBC" "BASIC";
The DELETEGROUP command deletes a group.
DELETEGROUP groupName
groupName | Name of the group to delete. |
Groups classify users with identical security requirements.
To delete a group called MARKETING:
DELETEGROUP "MARKETING";
The DELETELOCATION command removes a location alias from the current database.
DELETELOCATION alias
alias | Name of location alias to delete. |
This command deletes the specified location alias from the current database. You must have Database Designer privilege to delete location aliases.
DELETELOCATION "ALIAS3";
The DELETELOG command delete accumulated entries from an application log file or the Agent log file.
DELETELOG appName
appName | Name of application. If you do not specify appName, Hyperion Essbase clears the Agent log file. |
Each application has a log file, which records all user requests and activities in all databases in the application. The log file should be cleared 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 clears the Agent log file.
To clear the log file of an application called SAMPLE:
DELETELOG "SAMPLE";
To clear the Agent log file:
DELETELOG ""
The DELETEUSER command deletes a user ID.
DELETEUSER userName
userName | Name of the user to delete. |
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.
To delete a user named DANTE:
DELETEUSER "DANTE";
The DELETEVARIABLE command removes an existing substitution variable.
DELETEVARIABLE variableName serverName [appName [dbName]]
variableName | Name of the substitution variable to delete. |
serverName | Name of the server from which the variable is deleted. |
appName | Optional. Name of the application from which the variable is deleted. |
dbName | Optional. Name of the database from which the variable is deleted. |
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.
DELETEVARIABLE "CurQtr" "Bamboo" "Sample" "Basic";
The DISABLELOGIN command is used to prevent users from logging in to any databases in an application. Supervisors, and application designers for the application, are not affected by this setting.
DISABLELOGIN [appName]
appName | Optional. Application name required only if no application is selected. |
Issue the DISABLELOGIN command if you must prevent users from accessing databases in an application while you perform maintenance on it. Supervisors, and users currently connected to the application, will not be affected.
The DISABLELOGIN command prevents any user with a permission lower than Application designer from making connections to the databases that require the databases to be started. This includes starting the databases or performing the SELECT command on the databases. Database connections remain disabled until re-enabled by the administrator, using ENABLELOGIN or the application settings. By default, connections are enabled.
DISABLELOGIN;
The DISPLAYALIAS command lists the alias names defined in an alias table.
DISPLAYALIAS aliasTableName
aliasTableName | Name of the alias table to display. |
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.
To display the alias names defined in an alias table called DEFAULT:
DISPLAYALIAS "DEFAULT";
The ENABLELOGIN command is used to enable connections to databases in an application.
ENABLELOGIN [appName]
appName | Optional. Application name required only if no application selected. |
This command enables connections to an application, reversing the effect of DISABLELOGIN.
ENABLELOGIN;
The ENDARCHIVE command restores the database to read-write mode after archiving is complete.
ENDARCHIVE appName dbName
appName | Name of the application containing the archived database. |
dbName | Name of the archived database. |
After you call BEGINARCHIVE, use ENDARCHIVE to restore the database to 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.
ENDARCHIVE;
The ENDINCBUILDDIM command ends the programming block started by BEGININCBUILDDIM and restructures the database after one or more incremental, dimension-building (INCBUILDDIM) commands.
ENDINCBUILDDIM preserve
preserve | Specifies whether to preserve existing data in the database. This parameter is required. 1 - Preserves all existing data blocks. 2 - Preserves existing level 0 data. 3 - Preserves existing input-level data. 4 - Discards all existing data. |
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.
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;
The ESTIMATEFULLDBSIZE command provides an estimate of the number of blocks a database will create after calculation, based on the number of blocks that exist before calculation. You can use this estimate to help you plan disk space requirements.
ESTIMTAEFULLDBSIZE
You can select an application and database, then issue this command. Essbase returns the number of blocks the database creates. The database can have all data loaded, or it can have a random sampling of data loaded.
To obtain the estimated size of the database after a CALC ALL, use the procedure in the Database Administrator's Guide.
Assume that you have fully loaded Sample Basic and performed a CALC ALL command on it. This example shows the command and the output that results:
estimatefulldbsize; Estimated count of blocks after full calculation = 335
The EXIT command is used to exit the ESSCMD utility.
EXIT
This command ends the ESSCMD session and closes the window.
EXIT;
The EXPORT command writes the data values of a database to an ASCII text file.
EXPORT exportName amount formatOption
exportName |
Specifies the name, including the path, of the file for the exported data. If no path is specified, the file is created in the ARBORPATH\app directory. |
||||||
amount | Specifies the number representing the data to export.
|
||||||
formatOption | Specifies the format of the data.
|
The EXPORT command copies data in ASCII format as an alternative to database archiving wherein you copy the files in binary format. ASCII format is more flexible because it is more easily ported to other databases and users can easily read it. The EXPORT command exports only the data, rather than the entire database. Because only data is exported, it is more complex to restore the database from an export file than from a true database archive. You must reload and recalculate the data if you use an export file to restore a database.
Some file management systems do not support ASCII files larger than 2 GB.
If the exported data exceeds 2 GB, Essbase creates multiple
export files, as needed. An underscore and number is appended to the file names
of the additional files, starting with _1. For example, if exportName
is outfile.txt
and three files are created, the resulting file
names are outfile.txt, outfile_1.txt,
and outfile_2.txt
.
The export process does not begin until all users are logged out of the database. After the export process begins, the database is in read-only mode. Users can read the data but they cannot change it. After the export process is finished, Essbase returns the database to read-write mode and users can make changes to the data.
To create an export file called E060693
that contains only level zero data in columnar format:
EXPORT "E060693" 2 1;
If the exported data in this example exceeds 4 GB, three files are created:
E060693, E060693_1
, and E060693_2
.
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.
1. GETALLREPLCELLS sourceServerName sourceAppName sourceDbName
2. GETALLREPLCELLS ALL
sourceServer | Name of the data source server from which cells are replicated. |
sourceApp | Name of the data source application from which cells are replicated. |
sourceDb | Name of the data source database from which cells are replicated. |
ALL | Updates cells for all partitions where the selected database is a data replication target. |
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.
GETALLREPLCELLS "Aspen" "Sample" "Basic";
GETUPDATEDREPLCELLS
PUTALLREPLCELLS
The GETAPPACTIVE command returns the name of the currently selected application.
GETAPPACTIVE
This command returns the name of the currently selected application.
GETAPPACTIVE;
The GETAPPINFO command returns server, user, and database information for the current application.
GETAPPINFO [appName]
appName | Optional. Required only if no application is selected. |
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.
GETAPPINFO;
The GETAPPSTATE command returns information on the state of the currently selected application.
GETAPPSTATE [appName]
appName | Optional. Required only if no application is selected. |
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.
GETAPPSTATE;
The GETATTRIBUTESPECS command returns the current attribute specifications for the selected application and database.
GETATTRIBUTESPECS
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.
GETATTRIBUTESPECS;
Returns:
---------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 | Resulting Member name |
Prefix/Suffix : Prefix Use Name of : None Delimiter : '_' |
3000000 |
Prefix/Suffix : Prefix Use Name of : Parent Delimiter : '_' |
Small_3000000 |
Prefix/Suffix : Prefix Use Name of : All Ancestors Delimiter : '^' |
Population^Small^3000000 |
The GETATTRINFO command returns attribute member, dimension, and name information for given attribute members.
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 |
This command returns the following information for a member of an attribute dimension:
20
for the attribute member named Ounces_20
.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
GETATTRINFO "Caffeinated_True";
Returns:
Member info of [caffeinated_true] ------------------------------------ MbrName : Caffeinated_True DimName : Caffeinated Attribute Type : Boolean Attribute Value : True
The GETCRDB command returns the name of the currency database that is linked to the currently selected database.
GETCRDB
This command returns the name of the currency database that is linked to the currently selected database.
GETCRDB;
GETCRDBINFO
GETCRRATE
GETCRTYPE
The GETCRDBINFO command returns information about the currency database that is linked to the currently selected database.
GETCRDBINFO
This command returns information about the currency database that is linked to the currently selected database.
GETCRDBINFO;
The GETCRRATE
command returns the currency rate
for every currency partition.
GETCRRATE
This command returns the currency rate for every currency partition.
GETCRRATE;
The GETCRTYPE command returns information about the default currency type and conversion method.
GETCRTYPE
This command returns information about the default currency type and conversion method.
GETCRTYPE;
The GETDBACTIVE command returns the name of the currently selected database.
GETDBACTIVE
This command returns the name of the currently selected database.
GETDBACTIVE;
The GETDBINFO command returns information on the state of the currently selected database.
GETDBINFO [appName dbName]
appName dbName | Optional. Both parameters required if no application and database are selected. |
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.
GETDBINFO;
Returns:
----- 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 : 10 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 2001 End Time : Mon Aug 16 11:43:22 2001 Request Type : Default Calculation User Name : admin Start Time : Thu Aug 12 12:57:45 2001 End Time : Thu Aug 12 12:57:46 2001 Request Type : Outline Update User Name : admin Start Time : Mon Aug 16 12:39:27 2001 End Time : Mon Aug 16 12:39:30 2001
The GETDBSTATE command returns the most recently entered database settings information for the currently selected database.
GETDBSTATE [appName dbName]
appName dbName | Optional. Both parameters required if no application and database are selected. |
This command returns the most recently entered settings for the currently selected database. For settings currently in effect, see GETDBINFO.
GETDBSTATE;
Returns:
---------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 I/O Access Mode (in use) : Buffered I/O Access Mode (pending) : Buffered Direct I/O Type (in use) : N/A
The GETDBSTATS command returns detailed statistics for the currently selected database.
GETDBSTATS
This command returns information about dimensions and data blocks for the
currently selected database.
GETDBSTATS;
Returns:
-------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 Ounces SPARSE 5 5 Pkg Type SPARSE 3 3 Population SPARSE 15 15 Intro Date SPARSE 8 8 Number of dimensions : 10 Declared Block Size : 1615 Actual Block Size : 192 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 Average Clustering Ratio : 1 Average Fragmentation Quotient : 0
For information about how to use the Average Fragmentation Quotient, see the Database Administrator's Guide section about monitoring performance.
GETDBACTIVE
GETDBINFO
GETDBSTATE
The GETDEFAULTCALC command returns the default calculation script of the currently selected database.
GETDEFAULTCALC
The default calculation 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 calculation script.
GETDEFAULTCALC;
Returns:
Default calculation script name-- CALC ALL;
The GETMBRCALC command returns the calc string associated with the selected member.
GETMBRCALC mbrName
mbrName | Member name |
This command returns the member calc string.
GETMBRCALC "Profit %";
Returns the following:
Outline Defined Calc Equation. [Profit % Sales;] Last Calculated Calc Equation. [Profit % Sales;]
The GETMBRINFO command returns information on a specific member.
GETMBRINFO mbrName
mbrName | Member name |
This command returns the following information on a specific member:
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
The GETMEMBERS command returns a list of members from the currently selected database.
GETMEMBERS [mbrString]
mbrString | Optional. Dimension or member name. If specified, returns children of named dimension or member. The default is NULL, which returns a list of dimensions in the database. |
This command returns a list of members from the currently selected database.
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";
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.
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
]
sourceServerName | Name of the data source server where the outline changes were made. |
sourceAppName | Name of the data source application where the outline changes were made. |
sourceDbName | Name of the data source database where the outline changes were made. |
sourcePartitionType |
Name of the partition type where
the outline changes were made. Can
be any of the following: 1 - Replicated 2 - Linked 3 - Transparent |
getAllOtlChanges | Lists all changes to the database outline. Values: Y/N. |
getAllDimChanges | Lists all changes to the dimensions, including member names. Values: Y/N. |
getNewDim | Lists newly created dimensions. Values: Y/N. |
getDeletedDim | Lists deleted dimensions. Values: Y/N. |
getUpdatedDim | Lists updated dimensions. Values: Y/N. |
getMovedDim | Lists moved dimensions. Values: Y/N. |
getRenamedDim | Lists renamed dimensions. Values: Y/N. |
getAllMbrChanges | Lists all member changes. Values: Y/N. |
getNewMbrs | Lists newly created members. Values: Y/N. |
getDeletedMbrs | Lists deleted members. Values: Y/N. |
getRenamedMbrs | Lists renamed members. Values: Y/N. |
getMovedMbrs | Lists moved members. Values: Y/N. |
getAllMbrAttribChanges | Lists all changes to member attributes. Values: Y/N. |
getChngedMbrStatus | Lists members that have a changed status such as data storage or Dynamic Time Series information. Values: Y/N. |
getChngedMbrAlias | Lists changed member aliases. Values: Y/N. |
getChngedMbrCalcSym | Lists changed member unary operators. Values: Y/N. |
getChngedMbrAcctType | Lists changed account type information for members in an Accounts dimension. Values: Y/N. |
getChngedMbrCurrCnvInfo | Lists changed member currency conversion information. Values: Y/N. |
getChngedMbrUda | Lists changed member user-defined attributes. Values: Y/N. |
getChngedMbrCalcFormulas | Lists changed member calc formulas. Values: Y/N. |
getChangedLevNbr | Lists changed level numbers. Values: Y/N. |
getChangedGenNbr | Lists changed generation numbers. Values: Y/N. |
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.
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";
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.
1. GETUPDATEDREPLCELLS sourceServerName sourceAppName sourceDbName
2. GETUPDATEDREPLCELLS ALL
sourceServerName | Name of the data source server from which cells are replicated. |
sourceAppName | Name of the data source application from which cells are replicated. |
sourceDbName | Name of the data source database from which cells are replicated. |
ALL | Updates cells for all partitions where the selected database is a data replication target. |
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.
GETUPDATEDREPLCELLS "Aspen" "Sample" "Basic";
PUTUPDATEDREPLCELLS
GETALLREPLCELLS
The GETUSERINFO command returns information about a specified user or group.
GETUSERINFO userName
userName | Name of the user or group. |
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.
GETUSERINFO "TomT";
The GETVERSION command returns the version number and patch number information on the current Hyperion Essbase server software installation.
GETVERSION
This command returns the version number and patch number for the current server software installation.
GETVERSION;
The GOTO command skips all commands until it encounters the associated label.
GOTO "Label"; <SKIPPED COMMANDS> :Label ; <COMMANDS OR EOF>
"Label" | A string of ASCII characters; not case-sensitive. |
:Label | Target location, preceded by a colon (:) and associated with "Label". Processing skips to this label. |
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.
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 */
The HELP command provides a list of all available commands.
HELP ?
? | Lists all available commands. |
If you enter "?", you see a list of all ESSCMD supported commands.
To see a list of all available commands:
HELP ?;
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.
IFERROR "Label"; <SKIPPED COMMANDS> :Label ; <COMMANDS OR EOF>
"Label" | String of ASCII characters, terminated by a whitespace; not case-sensitive. |
:Label | Target location, preceded by a colon (:), and associated with "Label". Processing skips to this label. |
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.
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 */
The IMPORT command loads data values from an external source into the currently selected database.
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]
numeric | Location of the dataFile file. Values: 1 - Local/client data file. 2 - Remote/server data file. 3 - File. 4 - SQL source. |
dataFile | Name of data source file. |
fileType | File type of dataFile. Values: 1 - Excel file. 2 - Lotus 2 file. 3 - Lotus 3 file. 4 - Text file. 5 - Lotus 4 file. |
y/n | Whether to use rules when importing dataFile. |
ruleLoc | Location of the rulobjName file. Values: 1 - Local/client rule object file 2 - Remote/server rule object file 3 - File. Use option 3 if the file is not a Hyperion Essbase object, or if you want to specify the full path name. Otherwise, Hyperion Essbase looks in the < APPNAME >/<DBNAME > directory. |
rulobjName | Name of the rules file. |
y/n | Whether to abort on error. |
SQLUserName | User name that connects to the SQL database. |
SQLUserPassword | User password for the SQL database.. |
ErrorFile | The name of the error file. This is required only if you choose not to abort on error. |
For information on importing data values, see the Database Administrator's Guide.
IMPORT 2 "ACTUALS" 4 "Y" 2 "ACTUALS" "Y";
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.
INCBUILDDIM location rulobjName dataLoc sourceName fileType errorLog appendLog
location | Location of the rules file. Values: 1 - Local/client-based rules object 2 - Remote/server rules object 3 - File. Use option 3 if the file is not a Hyperion Essbase object, or if you want to specify the full path name. Otherwise, Hyperion Essbase looks in the < APPNAME >/<DBNAME > directory. |
rulobjName | Name of the rules file. |
dataLoc | Location of the data file. Values: 1 - Local/client data file 2 - Remote/server data file 3 - File. Use option 3 if the file is not a Hyperion Essbase object, or if you want to specify the full path name. Otherwise, Hyperion Essbase looks in the < APPNAME >/<DBNAME > directory.4 - SQL source |
sourceName | Source of the data file. Values:
|
fileType | Data file type. Values: 1 - Excel file 2 - Lotus .WK1 file. 3 - Lotus .WK3 file. 4 - Text file 5 - Lotus .WK4 file. This parameter is not required if you are using a SQL source. |
errorLog | Name of text file to receive error messages and rejected records. Each INCBUILDDIM command in a BEGININCBUILDDIM...ENDINCBUILDDIM block can specify a different error log. |
appendLog | Specifies whether to append to the error log
file or overwrite it. Values: 1 - Append 2 - Overwrite |
This command changes dimensions in the .OTN file according to the specified rules and data files. See BEGININCBUILDDIM for information on the .OTN file.
Each rules file can build one or more dimensions. If a rules files builds multiple dimensions and an error occurs in a record for any given dimension, Hyperion Essbase rejects the entire record. As a result, other dimensions represented in that record might not build correctly. In such a case, consider designing dimension builds with multiple rules files using INCBUILDDIM.
One common example of this problem relates to the Add as Child build method. Break the rules file into multiple rules files if both of the following circumstances apply:
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:
The following command builds the dimensions specified in GENREF.RUL and LEVELMUL.RUL, discards all data, and saves 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;
BUILDDIM
BEGININCBUILDDIM
ENDINCBUILDDIM
The LISTALIASES command returns a list of alias tables that are defined for the currently selected database.
LISTALIASES
The LISTALIASES command returns a list of alias tables that are defined for the currently selected database.
LISTALIASES;
The LISTAPP command returns a list of applications that are defined on the server.
LISTAPP
The LISTAPP command returns a list of applications that are defined on the server.
LISTAPP;
The LISTDB command returns a list of databases that are contained within the currently selected application.
LISTDB
The LISTDB command returns a list of databases that are contained within the currently selected application.
LISTDB;
The LISTFILES command helps track the amount of disk space used by Hyperion Essbase databases, by supplying accurate index and data file information.
LISTFILES fileType appName dbName
fileType | Type of file for which to display information.
Values:
|
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. |
The LISTFILES 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.
LISTFILES;
Returns:
----- 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)
The LISTFILTERS command lists the filters in a database.
LISTFILTERS appName dbName
appName | Name of the application containing the filters. |
dbName | Name of the database containing the filters. |
The LISTFILTERS command lists the filters in a database.
LISTFILTERS "FINANC95" "SALES95";
The LISTGROUPS command returns a list of groups that are defined on the server.
LISTGROUPS
Use the LISTGROUPS command to classify users with identical security requirements.
LISTGROUPS;
The LISTGROUPUSERS command returns a list of users that belong to a specified group.
LISTGROUPUSERS groupName
groupName | Name of the group for which to return a list of users. |
The LISTGROUPUSERS command enables classification of users with identical security requirements.
To return a list of all users that belong to the group called MARKETING:
LISTGROUPUSERS "MARKETING";
The LISTLINKEDOBJECTS command lists information about the objects linked to the active database for a given user name or modification date.
LISTLINKEDOBJECTS userName modDate
userName | The name of a user. If specified, Hyperion Essbase returns a list of all objects last modified by the given user. |
modDate | A modification date. If specified, Hyperion Essbase returns a list of all objects modified on or before the given date. |
The LISTLINKEDOBJECTS 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.
To list all objects last modified by user Diana on or before July 7, 1997:
LISTLINKEDOBJECTS "Diana" "07/07/1997";
The LISTLOCATIONS command displays all location aliases defined on the current database.
LISTLOCATIONS
The LISTLOCATIONS command displays the location alias parameters as defined and created with the CREATELOCATION command. You must have Database Designer privilege to list location aliases.
LISTLOCATIONS;
Returns:
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
The LISTLOGINS command returns the list of login instances in a session.
LISTLOGINS
The LISTLOGINS command returns the list of login instances in the current session.
LISTLOGINS;
The LISTLOCKS command returns a list of all users who have locks on blocks for the currently selected database.
LISTLOCKS [appName dbName]
appName dbName | Optional. Both parameters required if no application and database are selected. |
The LISTLOCKS command returns a list of all users who have locks on blocks for the currently selected database.
LISTLOCKS;
The LISTOBJECTS command returns a list of objects.
LISTOBJECTS number appName dbName
number |
Type of object to list. Values: 0 - Abort 1 - Outline object 2 - Calculation script 3 - Report script 4 - Rules object 5 - Alias table 6 - Structure file 7 - Backup file 8 - Worksheet of any type 9 - Text object 10 - Partition 11 - Linked Reporting Object (stored) 12 - Selection 13 - Wizard |
appName | Name of the application containing the objects. |
dbName | Name of the database containing the objects. |
The list of objects returned by the LISTOBJECTS 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.
To return a list of outline objects associated with the BASIC database:
LISTOBJECTS 1 "SAMPLE" "BASIC";
The LISTUSERS command returns a list of the users that are defined on the server.
LISTUSERS
The LISTUSERS command returns a list of the users that are defined on the server.
LISTUSERS;
The LISTVARIABLES command lists all substitution variables defined for a specified server.
LISTVARIABLES serverName [appName [dbName]]
serverName | Name of the server for which the variable is defined. |
appName | Optional. Name of the application for which the variable is defined. |
dbName | Optional. Name of the database for which the variable is defined. |
The LISTVARIABLES command lists all existing substitution variables and their corresponding values for a specified server, application, or database.
LISTVARIABLES "Bamboo" "Sample" "Basic";
The LOADALIAS command loads an alias table to the currently selected database.
LOADALIAS aliasName fileName
aliasName | Name of the alias table to load. |
fileName | Name of the feeder file that loads into the table. Must be in the format required to import an alias table. |
Refer to the Database Administrator's Guide for more information about alias tables in a database.
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";
The LOADAPP command is used to load an application and its respective databases into memory.
LOADAPP appName
appName | Name of the application to load. |
The LOADAPP command loads an application and databases into memory. In order for users to access information in databases, the application or individual database must be loaded.
To load an application called Sample into memory on the server:
LOADAPP "Sample";
The LOADDATA command loads data without a rules file.
LOADDATA numeric fileName
numeric |
Location of the data file. Values: 1 - Local/client-based rules object (file). 2 - Remote/server data file. 3 - File. Use option 3 if the file is not a Hyperion Essbase object, or if you want to specify the full path name. Otherwise, Hyperion Essbase looks in the < APPNAME >/<DBNAME > directory. |
fileName | Name of the file to load. |
The LOADDATA loads data without a rules file. The numeric parameter value tells Hyperion Essbase the location of fileName.
LOADDATA 2 "calcdat";
The LOADDB command loads a database into memory.
LOADDB appName dbName
appName | Name of the application in which the database resides. |
dbName | Name of the database to load. |
The LOADDB loads a database into memory. A database must be loaded in order for users to access its information.
To load a database called BASIC from an application called SAMPLE:
LOADDB "SAMPLE" "BASIC";
The LOGIN command is used to log in to the server.
LOGIN hostNode userName password [appName dbName]
hostNode | Server name. |
userName | User ID defined on the Hyperion Essbase server. |
password | User's password. |
appName | Optional. Name of the application to load. |
dbName | Optional. Name of the database to load. |
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.
To log in 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";
The LOGOUT command is used to log out of the server.
LOGOUT
The LOGOUT command logs you out of the server, but does not exit the ESSCMD session.
LOGOUT;
The LOGOUTALLUSERS command logs out all users from the Hyperion Essbase server.
LOGOUTALLUSERS Y|N
Y|N | Sets whether users are logged out. |
Use the LOGOUTALLUSERS command to log out all users from the Hyperion Essbase server. This command logs out all users, except the user issuing the command.
LOGOUTALLUSERS "Y";
The LOGOUTUSER command logs a specific user off the server.
LOGOUTUSER userNumber
userNumber | Login ID number associated with a user. Issue LOGOUTUSER with no parameter to display a list of users and user numbers. |
The LOGOUTUSER 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.
To log the user whose user number is 1 off the server:
LOGOUTUSER 1;
The OUTPUT command directs process information output from the ESSCMD session to a text file.
OUTPUT outputType [outputName] | [errorName]
outputType |
Number representing output operation.
Values: 1 - Outputs all process information. 2 - Outputs only errors. 3 - Stops output of process information. 4 - Stops output of errors. |
outputName | Required for outputType 1 only. Name of file to receive output. Not used with other values for outputType. |
errorName | Required for outputType 2 only. Name of file to receive errors. Not used with other values for outputType. |
The OUTPUT command directs Essbase to send messages from the ESSCMD session to the specified file instead of to the screen.
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"
Result: Essbase writes performance statistics to the file "stats
"
instead of to the screen.
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";
The PAREXPORT command starts the parallel export process.
PAREXPORT [-threads n] [-in input_filename] | [output_filename] amount formatOption
-threads n | Overrides the default number of export threads set in the
EXPORTTHREADS setting in the essbase.cfg file. The maximum
value is 8. If n is greater than 8, Essbase assumes the value to
be 8.
|
||||||
-in input_filename | Specifies the name of an input file that contains a list of
export file names. The number of files listed in the input file must match
the number of export threads. Parallel export gracefully errors out if there
is a mismatch.
|
||||||
output_filename | Specifies the root for the file names created to contain the
export data. For each thread, a number is appended to the specified output_filename. For example, if outfile_filename is outfile and two threads are specified, the resulting file names are outfile1 and outfile2 . If the data for a thread exceeds 2 GB, that
export data is divided into multiple files with a second number appended to the file names. See Note for details.
|
||||||
amount | Specifies the number representing the data to export.
|
||||||
formatOption | Specifies the format of the data.
|
The PAREXPORT command enables users to perform the export process in parallel. With this command, users can override the default number of export threads specified in the EXPORTTHREADS setting, and they can provide a list of export file names. During the export process, multiple threads can retrieve data and write to their corresponding export files concurrently.
Parallel export creates 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.
The export process does not begin until all users are logged out of the database. After the export process begins, the database is in read-only mode. Users can read the data but they cannot change it. After the export process is finished, Essbase returns the database to read-write mode and users can make changes to the data.
Note: If the data for an export thread exceeds 2 GB, that data
is separated into multiple files. Each file is less than 2 GB. The
first file name retains the original name; Essbase appends _1
,
_2
, and so on, as needed, to the additional files.
PAREXPORT -threads 4 -in e:\data\input.txt 1 1;
Note: | e:\data\input.txt is an ASCII file that contains
four file names on separate lines;that is, |
e:\data\export1.txt |
In this example, all data in the database is divided among four export threads to create four export files. The data is exported in columnar format.
If the data intended for a file is greater than 2 but less than 4 GB,
Essbase creates two files. For example,
for the data apportioned to e:\data\export2.txt
, Essbase would create
e:\data\export2.txt
and e:\data\export2_1.txt.
EXPORT
EXPORTTHREADS configuration setting
The PRINTPARTITIONDEFFILE command produces an ASCII text file of the partition-mapping tables of the distributed database.
PRINTPARTITIONDEFFILE location [ddbFileName] textFileName
location | Possible values: 1- Local/client file with a . DDB file
extension that is stored in the directory
pointed to by ARBORPATH . The
ddbFileName is automatically retrieved.2- Remote/server . DDB file. The
ddbFileName is automatically retrieved.3- Local/client file not stored in the ARBORPATH , or without a .DDB file
extension. The ddbFileName is required
when using this option. |
ddbFileName | The name of the partition mapping definition
.DDB file from which to read information. This is usually the
name of the database; for example, BASIC.DDB .If location is 1 or 2, ddbFileName is not required. If location is 3, the full path, file name, and file extension of the file is required. |
textFileName | The full path, file name, and file extension of the ASCII text output file to create. |
The ASCII text file contains the following information for each partition:
PRINTPARTITIONDEFFILE 2 "basic.ddb" "basic.txt";
The PURGELINKEDOBJECTS command deletes objects linked to the active database for a given user name or modification date.
PURGELINKEDOBJECTS userName modDate
userName | The name of a user. If userName is specified, Essbase deletes all objects last modified by the given user. |
modDate | A modification date. If modDate is specified, Essbase deletes all objects modified on or before the given date. |
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.
To delete all objects last modified by user Diana on or before July 7, 1997:
PURGELINKEDOBJECTS "Diana" "07/07/1997";
The PURGEOTLCHANGEFILE command deletes outline
changes that already have been applied from the .CHG
log file.
PURGEOTLCHANGEFILE serverName appName dbName partitionType direction
serverName | Name of the server from which to
delete .CHG information. |
appName | Name of the application from which to
delete .CHG information. |
dbName |
Name of the database from which to
delete .CHG information. |
partitionType | Name of the partition type to which the deletions are applied: 1 - Replicated. 2 - Linked. 3 - Transparent. |
direction |
Values:
|
The PURGEOTLCHANGEFILE command deletes outline changes that have already
been applied from the .CHG
file for the selected database, based
on parameters that you supply.
PURGEOTLCHANGEFILE "BAMBOO" "Sample" "Basic" 1 "Source";
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.
1: PUTALLREPLCELLS targetServerName targetAppName targetDbName
2: PUTALLREPLCELLS ALL
targetServerName | Name of the data target server to which cells are replicated. |
targetAppName | Name of the data target application to which cells are replicated. |
targetDbName | Name of the data target database to which cells are replicated. |
ALL | Updates all cells in partitions where the selected database is a data replication source. |
The PUTALLREPLCELLS 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.
PUTALLREPLCELLS "Aspen" "Sample" "Basic";
GETALLREPLCELLS
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.
1: PUTUPDATEDREPLCELLS targetServerName targetAppName targetDbName
2: PUTUPDATEDREPLCELLS ALL
targetServerName | Name of the data target server to which changed cells are replicated. |
targetAppName | Name of the data target application to which changed cells are replicated. |
targetDbName | Name of the data target database to which changed cells are replicated. |
ALL | Updates all changed cells in all partitions where the selected database is a data replication source. |
The PUTUPDATEDREPLCELLS command takes all changed replicated data cells from the selected data source server, application, and database, and replicates them in the data target database.
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, Essbase performs an internal search that identifies blocks without time stamps. 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.
PUTUPDATEDREPLCELLS "Aspen" "Sample" "Basic";
GETUPDATEDREPLCELLS
PUTALLREPLCELLS
The REMOVEUSER command removes a user from a group.
REMOVEUSER groupName userName
groupName | Name of group from which to remove user. |
userName | Name of the user to remove. |
Groups are used to classify users with identical security requirements.
To remove the user DANTE from the group called INTERNTL:
REMOVEUSER "INTERNTL" "DANTE";
The REMOVELOCKS command removes any locks that a specified user has acquired through a spreadsheet operation.
REMOVELOCKS userNumber
userNumber | Login ID of the user for whom you are removing locks. |
Removing locks is sometimes required for maintenance-related activities. Removing a users lock forces a logout of that users session.
To remove all locks that are held by user number 1 on the currently selected database:
REMOVELOCKS 1;
The RENAMEAPP command renames an existing application.
RENAMEAPP sourceApp newAppName
sourceApp | Name of existing application. |
newAppName | New name for application. |
The RENAMEAPP command renames an existing application.
RENAMEAPP "FINANC95" "ANNFIN95";
The RENAMEDB command renames an existing database.
RENAMEDB sourceApp sourceDb newDbName
sourceApp | Name of the application that contains the database to be renamed. |
sourceDb | Name of the database to be renamed. |
newDbName | New name for the database. |
The RENAMEDB command renames an existing database.
RENAMEDB "FINANC95" "SALES95" "95SALES";
The RENAMEFILTER command renames an existing filter.
RENAMEFILTER sourceApp sourceDb sourceFltr newFltrName
sourceApp | Name of the application that includes the filter. |
sourceDb | Name of the database that includes the filter. |
sourceFltr | Name of the existing filter. |
newFltrName | New name for filter. |
The RENAMEFILTER command renames an existing filter.
RENAMEFILTER "FINANC95" "SALES95" "FILTER95" "95FILT";
The RENAMEOBJECT command renames an existing object.
RENAMEOBJECT objType sourceApp sourceDb sourceObj newObjName
objType |
Type of object to rename. Values: 0 - Abort 1 - Outline object, not available 2 - Calculation script 3 - Report script 4 - Rules object 5 - Alias table 6 - structure file 7 - Backup file, not available 8 - Worksheet of any type, not available 9 - Text object 10 - Partition 11 - Selection 12 - Wizard |
sourceApp | Name of the application that includes the object. |
sourceDb | Name of the database that includes the object. |
sourceObj | Name of the existing object. |
newObjName | New name for the object. |
Two values for the objType parameter, 6 and 7, are retained only for backward compatibility with Release 2.0.
RENAMEOBJECT 2 "FINANC95" "SALES95" "OLDOBJ" "ARCHIVE";
The RENAMEUSER command renames an existing user.
RENAMEUSER userName newUserName
userName | Name of the existing user. |
newUserName | New name for the user. |
To rename a user, you must have Supervisor or other appropriate security privileges.
RENAMEUSER "NEWUSER" "D_ROSETTI";
The REPORT command is used to execute one or more report strings.
REPORT reportString
reportString | One or more report strings. |
When working with ESSCMD in interactive mode, use the REPORT command to enter one or more strings from a report script. Interactive ESSCMD prompts for a string each time you press the Enter key. When finished, end with a blank string.
To create a report based on all descendants of Qtr1, including the Qtr1 member, and all children of Market, including the Market member, enter the text shown in this color. In this example, ESSCMD prompts are in black. Instructions to press the Enter key are in this color.
local:sample:basic:admin(1)->REPORT Report: Enter blank string to end report Enter string ><IDESCENDANTS Qtr1(Press Enter) Enter string ><ICHILDREN Market(Press Enter) Enter string >!(Press Enter) Enter string > (Press Enter)
The REPORTLINE command is used to execute a single report string.
REPORTLINE reportString
reportString | Report string. |
The REPORTLINE command is used to execute a single report string.
To create a report based on all descendants of Year:
REPORTLINE "<DESCENDANTS YEAR !";
The RESETDB command clears all the data from the currently selected database.
RESETDB
This command is used to clear all the data from the currently selected database.
RESETDB;
The RESETOTLCHANGETIME command changes the time on the server you selected with the SELECT command, to match the time on another server.
RESETOTLCHANGETIME fromPartition toPartition
fromPartition includes the following parameters:
serverName | Name of the server from which the time change is applied. |
appName | Name of the application from which the time change is applied. |
dbName | Name of the database from which the time change is applied. |
partitionType |
The name of the type of partition
from which the time change is
applied. Values: 1 - Replicated 2 - Linked 3 - Transparent |
direction |
Values: Source - The selected database is used as a data source for the replicated, transparent, or linked partition. Target - The selected database is used as a data target for the replicated, transparent, or linked partition. |
toPartition includes the following parameters:
serverName | Name of the server to get the time change. |
appName | Name of the application to get the time change. |
dbName | Name of the database to get the time change. |
partitionType |
The name of the type of partition
the time change is applied to. Values: 1 - Replicated 2 - Transparent 3 - Linked |
direction |
Values:
|
The RESETOTLCHANGETIME 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.
RESETOTLCHANGETIME "BAMBOO" "SAMPLE" "BASIC" 1 "SOURCE" "ASPEN" "SAMPLE" "BASIC" 1 "TARGET";
GETPARTITIONOTLCHANGES
APPLYOTLCHANGEFILE
The RESETSTATUS command resets all saved status values to 0 (zero).
RESETSTATUS
The RESETSTATUS command is used in ESSCMD error handling.
RESETSTATUS resets:
RESETSTATUS;
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.
The RUNCALC command runs a calculation script.
RUNCALC numeric calcScript
numeric | Location of the calculation script data file. Values: 1 - Local/client-based calculation script. 2 - Remote/server calculation script. 3 - File. Use option 3 if the file is not a Hyperion Essbase object, or if you want to specify the full path name. Otherwise, Hyperion Essbase looks in the < APPNAME >/<DBNAME > directory. |
calcScript | Name of the calculation script to run. |
The numeric parameter indicates the location of the file named by the calcScript parameter.
To execute a calculation script object named FAM100 on the server:
RUNCALC 2 "FAM100";
The RUNREPT command runs a report script.
RUNREPT numeric reptScript outputFile
numeric | Location of the report script file. Values: 1 - Local/client-based report script. 2 - Remote/server report script. 3 - File is not a Hyperion Essbase object; enter a fully qualified path to the file. Use option 3 if you want to specify the full path name. Otherwise, Hyperion Essbase looks in the < APPNAME >/<DBNAME > directory. |
reptScript | Name of the report script to run. |
outputFile | Target file name for report output. |
The value you enter for the numeric parameter tells Essbase where the file named reportScript resides. Use the OUTPUT command to suppress the onscreen display of the script.
To execute a report script called P&L on the server:
RUNREPT 2 "P&L" "P&L.out";
The SELECT command is used to select an application and database.
SELECT appName dbName
appName | Name of the application containing the desired database. |
dbName | Name of database within the selected application. |
The SELECT command selects the application and database on which to focus subsequent commands.
To select the database called BASIC in the application called SAMPLE:
SELECT "SAMPLE" "BASIC";
The SETALIAS command sets an alias table as the primary table.
SETALIAS aliasName
aliasName | Name to set for the alias table. |
The SETALIAS command sets an alias table as the primary table for reporting and any additional alias requests.
SETALIAS "Long Names";
The SETAPPSTATE command defines application settings.
SETAPPSTATE ["appName"] "desc" Y/N Y/N
accessLevel
Y/N Y/N Y/N Y/N lockTimeout MaxLROFileSize;
appName | Name of the application. Do not include appName if the active application is selected. |
desc | Text string describing the application. |
Y/N | Sets whether the application is loadable. |
Y/N | Sets whether autoload occurs. |
accessLevel | Default access level. Values: 0 - None. 1 - Read. 2 - Write. 3 - Calculate. 4 - Application designer or database designer |
Y/N | Sets whether connections can be made. |
Y/N | Sets whether commands can be issued. |
Y/N | Sets whether updates can occur. |
Y/N | Sets whether security is enabled. |
lockTimeout | Maximum number of seconds that locks can be placed on blocks by Spreadsheet Add-in users. |
MaxLROFileSize | Maximum size, in kilobytes, for a Linked Reporting Objects (LRO) file. |
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.
SETAPPSTATE "sample" "The application is ready" "Y" "Y" 0 "Y" "Y" "Y" "Y" "3600";
The SETDBSTATE command defines database settings. For more options, see SETDBSTATEITEM.
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.
appName | Name of the application. Do not include if the application is already selected. |
dbName | Name of the database; required if appName is specified. |
desc | Text string describing the database. |
Y/N | Sets whether the database is loadable. |
Y/N | Sets autoload on or off. |
accessLevel | Default access level. Values: 0 - None. 1 - Read. 2 - Write. 3 - Calculate. 4 - Database designer. |
dataCacheSize | Maximum amount of server memory allocated for data cache. Default: 3145728 bytes. |
Y/N | Sets whether to aggregate missing values. |
Y/N | Sets whether or not to perform a Two-Pass calc. |
Y/N | Sets whether to create blocks on equations. |
currDb | Links a currency database. |
ccType | Specifies the default currency type member. |
0/1 | Sets the conversion method. Values: 0 - Division. 1 - Multiplication. |
indexCacheSize | Maximum amount of server memory allocated for index cache. Default: 1048576 bytes. |
indexPageSize | Maximum amount allocated for index page. Value: integer between 1024 and 8192 bytes. |
Y/N | Enable (Y) or disable (N) data compression on disk. |
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.
SETDBSTATE "Data has been updated" "Y" "Y" 4 "3000000" "N" "Y" "N" "" "" 0 "1049000" "1024" "Y";
The SETDBSTATEITEM command defines database settings by number, and provides more options than SETDBSTATE.
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.
Note: When changing sizes, valid size-entry units in ESSCMD are bytes (b), kilobytes (k), metabytes (m), gigabytes (g), or terabytes (t). Example: 8192b, 8k, 1m, ng, nt. If no size unit is given, the default unit is bytes (b).
optionNumber | An integer between 0 and 27, inclusive. This number corresponds to the options listed below. Enter 99 to be prompted for all options (in interactive mode). |
appName | Name of the application. Omit if the application is already selected. |
dbName | Name of the database; required if appName is specified. |
values |
Acceptable value or values; these vary from
option to option.
0. Abort 1. Description
2. Allow Database to Start?
3. Start Database with Application?
4. Access Level
5. Data Cache Size
6. Aggregate Missing Values?
7. Two Pass Calc When [CALC ALL]?
8. Create Blocks on Equation?
9. Currency Database Name
10. Currency Conversion Type Member
11. Currency Conversion Type
12. Index Cache Size
14. Data Compression on Disk?
15. Data Compression Type
16. Retrieval Buffer Size
17. Retrieval Sort Buffer Size
18. Isolation Level
Depending on which type of access you specify, ESSCMD prompts you for other parameters (or you can supply the values on the command line). If you choose 1 (committed access), ESSCMD prompts
for:
If you choose 2 (uncommitted access), ESSCMD
prompts for:
19. Pre Image Access?
20. Time Out
21. Number of blocks modified before internal commit
22. Number of rows to data load before internal commit
23. Add Disk Volume Definitions
ESSCMD prompts you for the following values, unless you supply them on the command line:
24. Modify Disk Volume Information
25. Delete Disk Volume Definition
For example, suppose you defined three volumes: first, C; then, E; then, D. Hyperion Essbase considers D the third volume - definition number 3. 26. Cache Memory Locking
27. Data File Cache Size
99. All Items
|
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.
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 GB on Volume E, sets a maximum file size of 1 GB, and specifies that data files should be stored only on E:
SETDBSTATEITEM 23 "SAMPLE" "BASIC" "1" "E" "4G" "2" "1G"
The SETDEFAULTCALC command sets a calculation string as the default database calculation.
SETDEFAULTCALC calcString
calcString | Calculation string to set. |
Place the default database calculation within quotation marks. Calculation strings require the ending semicolon.
SETDEFAULTCALC "CALC ALL;";
The SETDEFAULTCALCFILE command sets a calculation object as the default database calculation.
SETDEFAULTCALCFILE calcobjName
calcobjName | Calculation object to set. Give full path name if this object is not in the CLIENT directory. |
The SETDEFAULTCALCFILE command sets a calculation object as the default database calculation.
SETDEFAULT "actbud";
The SETHELP command changes the number of lines of command-listing output the ESSCMD HELP command displays on the screen at a time.
SETHELP numberLines
numberLines | Number of lines of lines of output the ESSCMD HELP command displays on the screen at a time. |
The SETHELP command changes the number of lines of command-listing output the ESSCMD HELP command displays on the screen at a time.
To set the display of commands listed to 10 lines:
SETHELP "10";
The SETLOGIN command sets the active login to a particular instance.
SETLOGIN sesNo
sesNo | Login instance session number. Values:
|
The SETLOGIN command provides a list of login instances. To get session numbers, use the LISTLOGINS command.
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
The SETMSGLEVEL command defines the level of messages seen in the interactive ESSCMD shell.
SETMSGLEVEL level
level | Level setting for messages. Values: 1 - Make no changes 2 - Display all information messages 3 - Display only warning messages 4 - Display only error messages 5 - Display no messages |
The SETMSGLEVEL command defines the level of messages seen in the interactive ESSCMD shell. To set the level of messages seen in an ESSCMD output file, use the OUTPUT command.
SETMSGLEVEL 3;
OUTPUT
AGENTLOGMESSAGELEVEL (.cfg
setting)
set message level (MaxL shell)
The SETPASSWORD command assigns a new password to an existing user.
SETPASSWORD userName newPassword
userName | Name of the existing user. |
newPassword | New password for the user. |
The SETPASSWORD command assigns a new password to an existing user.
SETPASSWORD "D_ROSETTI" "INFERNO";
The SHUTDOWNSERVER command lets you shut down the Agent from any terminal connected to it. You must have Supervisor privilege to use this command.
SHUTDOWNSERVER servername username password
servername | Name of the server you want to shut down. |
username | Your user name. |
password | Your password. |
The SHUTDOWNSERVER 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.
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";
The SLEEP command pauses an ESSCMD script.
SLEEP "seconds"
seconds | Number of seconds for the batch file execution to sleep. |
Pausing an ESSCMD batch file allows other commands to finish execution and cleanup.
SLEEP "10";
The UNLOADALIAS command unloads the existing alias table.
UNLOADALIAS aliasName
aliasName | Name of the alias table to unload. |
The UNLOADALIAS command unloads the existing alias table.
UNLOADALIAS "LONG NAMES";
The UNLOADAPP command unloads an application from memory on the server.
UNLOADAPP appName
appName | Name of the application to unload. |
All databases within the application are unloaded.
UNLOADAPP "SAMPLE";
The UNLOADDB command is used to unload a database from memory on the server.
UNLOADDB appName dbName
appName | Name of the application in which the database resides. |
dbName | Name of the database to unload. |
The UNLOADDB command is used to unload a database from memory on the server.
UNLOADDB "SAMPLE" "BASIC";
The UNLOCKOBJECT command unlocks an existing object.
UNLOCKOBJECT objType sourceApp sourceDb sourceObj
objType |
Type of object to list. Values: 1 - Outline object. 2 - Calculation script. 3 - Report script. 4 - Rules object. 5 - Alias table (not available). 6 - Structure file (not available). 7 - Backup file (not available). 8 - Worksheet of any type (not available). 9 - Text object. 10 - Partition. 11 - Linked Reporting Object (stored). 12 - Selection. 13 - Wizard. |
sourceApp | Name of the application that includes object. |
sourceDb | Name of the database that includes object. |
sourceObj | Name of the existing object to unlock. |
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.
UNLOCKOBJECT 1 "FINANC95" "SALES95" "ARCHIVE";
The UPDATE command loads a single data record.
UPDATE dataString
dataString | A single data record. |
The UPDATE command loads a single data record.
UPDATE "Year Measures Product Market Scenario 12";
The UPDATEFILE command loads data, unlocks blocks, and verifies a data file.
UPDATEFILE location fileName update
location | Location of the data file. Values: 1 - Local/client-based rules object 2 - Remote/server data object 3 - File. Use option 3 if you want to specify the full path name. Otherwise, Hyperion Essbase looks in the <appname>/<DBNAME> directory |
fileName | Name of the file to load. |
update |
Update action. Values: 1 - Load data 2 - Unlock data blocks 3 - Verify data |
The UPDATEFILE command command loads data, unlocks blocks, and verifies a data file.
UPDATEFILE 2 "DATA" 1;
The UPDATEVARIABLE command updates the variable value that corresponds to the specified substitution variable.
UPDATEVARIABLE variableName [serverName [appName [dbName]]] value
variableName | The name of the existing substitution variable. |
serverName | Optional. Name of the connection server to which the variable is applied. |
appName | Optional. Name of the application to which the variable is applied. |
dbName | Optional. Name of the database to which the variable is applied. |
value | The new string value that corresponds to the substitution variable. The name must be alphanumeric, and can be a maximum of 255 characters. You can have a null value, but do not use a leading & character in the value. |
The UPDATEVARIABLE command updates the string value of the selected substitution variable.
UPDATEVARIABLE "CurQtr" "Bamboo" "Sample" "Basic" "Qtr2";
The VALIDATE command checks the database for data and structural integrity.
VALIDATE errorlogFile
errorlogFile | Name of destination file for error messages. Default: List file is in application\database directory. |
For example:
ESSBASE\APP\app\db\VALIDATE.LST
The VALIDATE command validates the current database. You must select a database before issuing the VALIDATE command.
The VALIDATE command checks the following information:
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).
VALIDATE;
The VALIDATEPARTITIONDEFFILE command validates shared partition definitions.
VALIDATEPARTITIONDEFFILE
The VALIDATEPARTITIONDEFFILE 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:
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.
VALIDATEPARTITIONDEFFILE
Copyright 1991-2002 Hyperion Solutions Corporation. All rights reserved.