ESSCMD Command Groups


This section lists ESSCMD commands, grouped by command type:

Using ESSCMD
Application and Database Administration
User/Group Security
Security Filters and Locks
Database Objects
Outline/Attribute Information
Dimension Building
Data Loading, Clearing, and Exporting
Calculating
Reporting
Partitioning
Outline Synchronization
Error and Log Handling
Currency Conversion Information
Location Aliases
Substitution Variables
Aliases
Integrity and Performance
Backing Up


Using ESSCMD

Use these commands to log in and out of ESSCMD, view a list of commands, pause an ESSCMD script, and redirect command output.

LOGIN
LISTLOGINS
SETLOGIN
HELP
SETHELP
SELECT
SLEEP
LOGOUT
EXIT


Application and Database Administration

Use these commands to perform database administration, and get information about applications and databases.

GETVERSION
CREATEAPP
DELETEAPP
COPYAPP
RENAMEAPP
LISTAPP
LOADAPP
GETAPPACTIVE
GETAPPINFO
GETAPPSTATE
SETAPPSTATE
UNLOADAPP
CREATEDB
DELETEDB
COPYDB
RENAMEDB
LISTDB
LOADDB
GETDBACTIVE
GETDBINFO
GETDBSTATE
SETDBSTATE
SETDBSTATEITEM
GETDBSTATS
UNLOADDB
LISTFILES
SHUTDOWNSERVER


User/Group Security

Use these commands to perform user and group administration.

DISABLELOGIN
ENABLELOGIN
LOGOUTUSER
LOGOUTALLUSERS
CREATEUSER
DELETEUSER
RENAMEUSER
LISTUSERS
GETUSERINFO
SETPASSWORD
CREATEGROUP
DELETEGROUP
LISTGROUPS
ADDUSER
REMOVEUSER
LISTGROUPUSERS


Security Filters and Locks

Use these commands to list, copy and rename security filters, and to view and remove database locks.

LISTFILTERS
COPYFILTER
RENAMEFILTER
LISTLOCKS
REMOVELOCKS


Database Objects

Use these commands to list database objects and their lock statuses, copy and rename database objects, and to view and remove URLs, cell notes, or partitions linked to the database.

LISTOBJECTS
COPYOBJECT
RENAMEOBJECT
UNLOCKOBJECT
LISTLINKEDOBJECTS
PURGELINKEDOBJECTS


Outline/Attribute Information

Use these commands to view member and attribute information, and view current attribute naming specifications for the database.

GETMBRINFO
GETMEMBERS
GETATTRINFO
GETATTRIBUTESPECS


Dimension Building

Use these commands to build one or more dimensions from data files or SQL sources. You can build multiple dimensions incrementally, with or without automatic restructuring after the dimension build is complete.

BUILDDIM
INCBUILDDIM
BEGININCBUILDDIM
ENDINCBUILDDIM


Data Loading, Clearing, and Exporting

Use these commands to load data files or individual records, to clear all data from the database, or to export and import data to and from a text file.

LOADDATA
UPDATE
UPDATEFILE
RESETDB
EXPORT
IMPORT


Calculating

Use these commands to run calc scripts, execute one or more calc strings, run or change the default calculation, and view information about calc strings associated with members.

CALC
CALCDEFAULT
CALCLINE
GETDEFAULTCALC
GETMBRCALC
RUNCALC
SETDEFAULTCALC
SETDEFAULTCALCFILE


Reporting

Use these commands to run report scripts and execute one or more report strings.

RUNREPT
REPORT
REPORTLINE


Partitioning

Use these commands to:

PRINTPARTITIONDEFFILE
GETALLREPLCELLS
PUTALLREPLCELLS
GETUPDATEDREPLCELLS
PUTUPDATEDREPLCELLS


Outline Synchronization

Use these commands to keep the target database outline synchronized with changes made to the source database outline. These commands utilize an outline change file (.CHG) to track changes made on the source outline, apply those changes to the target outline, and synchronize time stamps in the partition definition files.

GETPARTITIONOTLCHANGES
APPLYOTLCHANGEFILE
PURGEOTLCHANGEFILE
RESETOTLCHANGETIME


Error and Log Handling

Use these commands for conditional and unconditional error branching in ESSCMD scripts, redirection of process information, specifying what kind of server messages are displayed, and clearing the application log file.

RESETSTATUS
SETMSGLEVEL
GOTO
IFERROR
OUTPUT
DELETELOG


Currency Conversion Information

Use these commands to get information about the currency database linked to the currently selected database.

GETCRDB
GETCRDBINFO
GETCRRATE
GETCRTYPE


Location Aliases

Use these commands to manage location aliases in a distributed Hyperion Essbase environment. Location aliases are names representing server-application-database-user name-password combinations.

CREATELOCATION
DELETELOCATION
LISTLOCATIONS


Substitution Variables

Use these commands to manage substitution variables. Substitution variables are placeholders for information that changes regularly. Use them in calc scripts, report scripts, and the Hyperion Essbase Spreadsheet Add-in.

CREATEVARIABLE
DELETEVARIABLE
LISTVARIABLES
UPDATEVARIABLE


Aliases

Use these commands to manage and display the contents of alias tables for a database. Alias tables contain a listing of member names and their alternate names, or aliases. Create alias tables using Application Manager.

LISTALIASES
SETALIAS
LOADALIAS
UNLOADALIAS
DISPLAYALIAS


Integrity, Performance

Use these commands to get and reset performance statistics, and check for data integrity.

GETPERFSTATS
RESETPERFSTATS
VALIDATE


Backing Up

Use these commands to place a database in Read-only mode in preparation for archiving, and to restore the database to Read-write mode after archiving is complete.

BEGINARCHIVE
ENDARCHIVE


Copyright (c)1991-2000 Hyperion Solutions Corporation. All rights reserved.