1. Using Oracle Essbase
  2. Essbase Command-Line Interface (CLI)
  3. CLI Command Reference

CLI Command Reference

The Essbase CLI commands that you issue in the esscs shell help you perform routine platform operations including: calc, dataload, dimbuild, lcmexport, lcmimport, upload and download of artifacts, start and stop an application or cube, and more.

The following commands are available in the command-line interface. Arguments to commands can be issued in any order.

To display help for all commands, enter esscs -h. To display help for a specific command, enter esscs command -h.

To turn on verbose output for any command, meaning that extended information (if available) is displayed, enter esscs command -v command arguments.

Login/Logout: CLI Authentication

The login CLI command for Essbase authenticates you to Essbase so you can use the CLI.

Before you can issue any other CLI commands to Essbase, you must log in. If a secure connection is required, then the URL must begin with https.

You can authenticate in the following ways using CLI:

  • Use setpassword once to have the password stored for your client/user combination. In subsequent sessions, you can use the login command without being prompted to enter a password.
  • Use the -user and -password options with the login command (Caution: the password appears in the shell window as cleartext).
  • Use only the -user option with the login command. You are prompted to enter the password, which is hidden.

If you’re a federated SSO user in Oracle Identity Cloud Service, logging in using MaxL or CLI is not supported. Federated SSO login requires a browser window. Create a native Identity Cloud Service user, and use that instead to log in using MaxL or CLI.

Syntax (login)

login [-verbose] -essbaseurl https://instance-name.example.com/essbase -user username [-password password]
Option Abbreviation Description
-verbose -v Show extended descriptions
-essbaseurl -url Address of an instance of Essbase
-user -u User name
-password -p Optional. Password for user. Alternatively, set the password using setpassword.

If issuing the the login command from a script, and the password contains special characters, enclose it in double quotation marks (for example, "aNb3^5%9$!").

Use of $ (dollar sign) character within the Essbase password is not supported for logins in a Linux environment.

Example 1 (login)

esscs login -url https://myEssbase-test-myDomain.analytics.us2.example.com/essbase -u smith

Example 2 (login)

In the following example, the user logging in, admin1@example.com is an Identity Cloud Service administrator who was set as the initial Essbase administrator during Essbase stack deployment on Oracle Cloud Infrastructure. As the password is not entered in this example, the administrator will be prompted to provide it next. The URL is the essbase_url from the job outputs resulting from the stack deployment. 

esscs login -u admin1@example.com -url https://192.0.2.1/essbase

Syntax (logout)

logout

Example (logout)

esscs logout

Calc: Run a Calculation Script

The calc CLI command for Essbase executes a calculation script on the cube. To run this command, you need at least Database Update permission, as well as provisioned access to the calculation script.

Before you can run calculation scripts, you must first upload the scripts, as .csc files, to the cube directory. You can use the CLI to upload files. See Upload: Add Cube Files.

Syntax

calc [-verbose] -application appname -db cubename -script scriptfilename
Option Abbreviation Description
-verbose -v Show extended descriptions
-application -a Application name
-db -d Database (cube) name
-script -s Calculation script name. Must have .csc file extension. You do not need to give a full path. Files are assumed to be in the relevant cube directory.

Example

esscs calc -v -a Sample -d Basic -s CALCALL.CSC

You can also run calculation scripts using the Calculate option in Cube Designer or Smart View, Jobs in the Essbase web interface or REST API, or execute calculation in MaxL.

Clear: Remove Data from a Cube

The clear CLI command for Essbase clears data from a cube. To use this command, you need at least Database Update permission.

Syntax

clear [-verbose] -application appname -db cubename [-option clearOption[-regionspec regionSpec]]
Option Abbreviation Description
-verbose -v Optional. Show extended descriptions
-application -a Application name
-db -d Database (cube) name
-option -O Optional. Keyword specifying what to clear. Default option, if omitted, is ALL_DATA.

The options for block storage cubes are:

  • ALL_DATA—All data, linked objects, and the outline are cleared

  • UPPER_LEVEL—Upper level blocks are cleared

  • NON_INPUT—Non input blocks are cleared

The options for aggregate storage cubes are:

  • ALL_DATA—All data, linked objects, and the outline are cleared

  • ALL_AGGREGATIONS

    —All aggregated data is cleared

  • PARTIAL_DATA

    —Only specified data region is cleared. Use with -regionspec
-regionspec -rs MDX expression specifying the region to clear

Example

esscs clear -a ASOSamp -d Basic -O PARTIAL_DATA -rs "{([Jan],[Sale],[Cash])}"

You can also clear data using the Load Data option in Cube Designer, Jobs in the Essbase web interface or REST API, or alter database DBS-NAME reset in MaxL.

Createlocalconnection: Save a JDBC Connection

The createlocalconnection CLI command for Essbase creates a JDBC connection and stores it locally. To use this command, you need Service Administrator role.

Description

A service administrator must use this command to create and save the local connection before anyone can use the CLI dataload or dimbuild commands with the streaming option. You must also set an environment variable EXTERNAL_CLASSPATH to point to the .jar file for your database driver (see Build Dimensions and Load Data by Streaming from a Remote Database).

Syntax

createLocalConnection [-verbose] -name streamConnection -connectionstring  connectionString -user userName [-driver jdbcDriver] [-password password]
Option Abbreviation Description
-verbose -v Show extended descriptions
-name -N Connection name
-connectionstring -cs JDBC connection string. Format can be with SID, as follows:
jdbc:oracle:thin:@host:port:SID

or with service name, as follows

jdbc:oracle:thin:@host:port/service_name

The syntax formats above apply for Oracle Database. See Examples section for minor differences in the connection string syntax when you are working with other providers.
-user -u User name
-driver -D JDBC driver. If not provided, Oracle Database is considered the default, as oracle.jdbc.driver.OracleDriver
-password -p Password (optional)

If you have network connectivity between an external source of data and Essbase, it is most efficient to define application-level or global connections and Datasources in the Essbase web interface. These definitions help you to easily "pull" data from the external source. If you have no network connectivity between Essbase and the external source of data, then you can stream data loads or dimension builds using the CLI by first using this command to create a local connection, and then issuing the dataload or dimbuild command with the stream option.

Notes

After migrating to Release 21.4 or higher, the Service Administrator needs to recreate any saved local connections that were created using this command in a previous release.

Examples

If the -driver option and jdbcDriver parameter are not provided, Oracle database is the assumed database by default. 

esscs createLocalConnection -N OracleDBConnection1 -cs jdbc:oracle:thin:@myhostname01:1521:ORCL -u OracleUser -D oracle.jdbc.driver.OracleDriver

If the -driver option and jdbcDriver parameter are not provided, Oracle database is the assumed database by default. 

esscs createLocalConnection -N OracleDBConnection2 -cs jdbc:oracle:thin:@host1.example.com:1521/ORCL.esscs.host1.oraclecloud.com -u OracleUser

If the -driver option and jdbcDriver parameter are not provided, Oracle database is the assumed database by default. 

esscs createLocalConnection -N DB2conn -cs jdbc:db2://myhostname02.example.com:50000/TBC -u myDB2User -D com.ibm.db2.jcc.DB2Driver

If the -driver option and jdbcDriver parameter are not provided, Oracle database is the assumed database by default. 

esscs createLocalConnection -N MySQLconn -cs jdbc:mysql://myhostname03.example.com:3306/tbc -u MySQLUsr -D com.mysql.jdbc.Driver

If the -driver option and jdbcDriver parameter are not provided, Oracle database is the assumed database by default. 

esscs createLocalConnection -N MSSQLConn -cs jdbc:sqlserver://myhostname04.example.com:1433 -u MSSQLUsr -D com.microsoft.sqlserver.jdbc.SQLServerDriver

If the -driver option and jdbcDriver parameter are not provided, Oracle database is the assumed database by default. 

esscs createLocalConnection -N TeraDconn -cs jdbc:teradata://myhostname05.example.com/DBS_PORT=1025 -u TeraUsr -D com.teradata.jdbc.TeraDriver

Dataload: Load Data to a Cube

The dataload CLI command for Essbase loads data to a cube. To use this command, you need at least Database Update permission.

This command requires one of the following sets of options:

  • Data file and optional rule file

  • Rule file with user name and password

  • Stream option referencing a saved local connection

The source database should be accessible within the client network, as not all database drivers can work with Java proxies.

To load data, you must first upload the data load and rule files to the cube directory. You can use the CLI to upload files. See Upload: Add Cube Files.

Syntax

dataload [-verbose] -application appname -db cubename -file filename [| -catalogfile catalogFile] [-rule rulesFile | -catalogrulefile catalogRulesFile] [-user username [-password password]]  [-stream] [-connection connectionName][-query queryString] [-rows n]]  [-abortOnError]
Option Abbreviation Description
-verbose -v Show extended descriptions
-application -a Application name
-db -d Database (cube) name
-file -f Data load file name. You do not need to give a full path. Files are assumed to be in the relevant database directory. You can use -catalogfile in place of this option.
-rule -r Optional. Rule file name. You do not need to give a full path. Files are assumed to be in the relevant database directory. You can use -catalogrulefile in place of this option.
-catalogfile -CF Data load file name from the file catalog. You can use this option in place of -file.
-catalogrulefile -CRF Rule file name from the file catalog. You can use this option in place of -rule.
-user -u Optional. User name. Requires password if used.

If you are using a saved connection and Datasource, no user name and password are required. If you are not using a saved connection, and the rule file connects to an RDBMS, specify the user name and password to connect to the RDBMS.
-password -p Optional. Password for user. If omitted, user will be prompted for password.
-stream -S Optional. Use streaming data load. Requires -conn option if used.
-connection -conn Required if streaming option is used. Name of a saved connection that was created using the createlocalconnection CLI command.
-query -q Optional. Database query to submit along with the streaming data load.
-rows -rows Optional. Number of rows to stream simultaneously. Default is 100.
-abortOnError -abort Abort data load if error is encountered

Examples

esscs dataload -a Sample -db Basic -f Calcdat.txt -abort true
esscs dataload -a Sample -db Basic -r Basic.rul -S -conn oraConn -q "Select * from Data" -rows 50
esscs dataload -a Sample -db Basic -CF /users/weblogic/Data_Basic.txt -r Data.rul -abortonerror
esscs dataload -a Sample -db Basic -CF /users/weblogic/Data_Basic.txt -CRF /shared/Data.rul -abort
esscs dataload -a Sample -db Basic -CRF /shared/Data.rul -S -conn localConnectionName -q "Select * from Table"

You can also load data using Cube Designer, Jobs in the Essbase web interface or REST API, or import data in MaxL.

Deletefile: Remove Cube Files

The deletefile CLI command for Essbase removes cube artifacts from the application, database, or user home directory. To delete files from a cube, you need at least Database Manager permission for the cube. No special permissions are required to delete files from your user directory.

Syntax

deletefile [-verbose] -file fileName [-application application [-db  database] [| -catalogfile catalogFile]]
Option Abbreviation Description
-verbose -v Show extended descriptions
-file -f Name of the file to delete
-application -a Optional. Application name. If not provided, files are assumed to be in your user home directory.
-database -db Optional. Database (cube) name
-catalogfile -CF File path and name from the file catalog. You can use this option in place of -file.

Examples

esscs deletefile -a Sample -d Basic -f Act1.rul
esscs deletefile -CF /shared/Data.txt

You can also manage files in Cube Designer, the Essbase web interface, or REST API.

Deploy: Create a Cube from a Workbook

The deploy CLI command for Essbase creates a cube from an Excel application workbook. To run this command, you need at least Power User role.

Syntax

deploy [-verbose] -file fileName [-application application [-database database] | -catalogfile catalogFile] [-restructureoption restructureOption] [-loaddata] [-recreateapplication] [-createfiles] [-executescript]
Option Abbreviation Description
-verbose -v Show extended descriptions
-file -f Name of the application workbook file
-application -a Optional. Application name. If not provided, application name will be taken from the workbook.
-database -db Optional. Database (cube) name. If not provided, database name will be taken from the workbook.
-catalogfile -CF Application workbook from the file catalog. You can use this option in place of -file.
-loaddata -l Optional. Load data, if the application workbook contains a data worksheet. Otherwise, only metadata is imported into the cube.
-restructureoption -R Optional. Keyword indicating the desired restructuring option.

The options for block storage cubes are:

  • ALL_DATA—Preserve all data

  • NO_DATA—Preserve no data

  • LEAFLEVEL_DATA—Preserve level 0 (leaf level) data

  • INPUT_DATA—Preserve input data

The options for aggregate storage cubes are:

  • ALL_DATA—Preserve all data

  • NO_DATA—Preserve no data

-recreateapplication -ra Optional. Re-create the application, if it already exists
-createfiles -cf Optional. Create cube artifacts in the files directory in Essbase.
-executescript -e Optional. Execute calculation scripts. Applicable only if the application workbook contains a calculation worksheet with Execute Calc set to Yes in the definitions.

Examples

esscs deploy -v -a SampleD1 -d BasicD1 -f Sample_Basic.xlsx -l -ra -cf -e
esscs deploy -CF "/gallery/Applications/Demo Samples/Block Storage/Sample_Basic.xlsx" -a Sample1 -l -cf -e -R ALL_DATA

You can also deploy cubes using Cube Designer, or by using the Import option in the Applications section of the Essbase web interface.

Dimbuild: Load Dimensions to a Cube

The dimbuild CLI command for Essbase loads dimensions to a cube. To run this command, you need at least Database Manager permission for the cube.

Before you can load dimensions, you must first upload the dimension-build and rule files to Essbase. You can use the CLI to upload files. See Upload: Add Cube Files.

Syntax

dimbuild [-verbose] -application appname -db cubename -file fileName [| -catalogfile catalogFile] -rule rulesFile [| -catalogrulefile catalogRulesFile]] [-user userName [-password password]] [-stream] [-connection connectionName][-query queryString] [-rows n]] [-restructureOption restructureOption] [-forcedimbuild]
Option Abbreviation Description
-verbose -v Show extended descriptions
-application -a Application name
-db -d Database (cube) name
-file -f Dimension build file name. You do not need to give a full path. Files are assumed to be in the relevant application or database directory. You can use -catalogfile in place of this option.
-rule -r Rule file name. You do not need to give a full path. Files are assumed to be in the relevant application or database directory. You can use -catalogrulefile in place of this option.
-catalogfile -CF Dimension build file name from the file catalog. You can use this option in place of -file.
-catalogrulefile -CRF Rule file name from the file catalog. You can use this option in place of -rule.
-user -u Optional. User name. Requires password if used.

If you are using a saved connection and Datasource, no user name and password are required. If you are not using a saved connection, and the rule file connects to an RDBMS, specify the user name and password to connect to the RDBMS.
-password -p Optional. Password for user. If omitted, user will be prompted for password.
-stream -S Optional. Use streaming dimension build. Requires -conn option if used.
-connection -conn Required if streaming option is used. Name of a saved connection that was created using the createlocalconnection CLI command.
-query -q Optional. Database query to submit along with the streaming dimension build.
-rows -rows Optional. Number of rows to stream simultaneously. Default is 100.
-restructureOption -R

Controls your preservation choices for the outline restructure.

For block storage, possible options are:

  • ALL_DATA: Preserve all data when loading dimensions.
  • NO_DATA: Do not preserve data.
  • LEAFLEVEL_DATA: Preserve only level 0 data values. If all data required for calculation resides in level-0 members, then you should select this option. All upper-level blocks are deleted before the cube is restructured. When the cube is recalculated, the upper-level blocks are re-created.
  • INPUT_DATA: Preserve only input data.

For aggregate storage, possible options are:

  • ALL_DATA: Preserve all data when loading dimensions.
  • NO_DATA: Do not preserve data.

-forcedimbuild -F Continue the dimension build even if other user activities are in progress. This cancels active user sessions.

Examples

esscs dimbuild -a Sample -d Basic -r Basic.rul -u smith -p password -R NO_DATA -F
esscs dimbuild -a Sample -d Basic -r Basic.rul -S -conn oraConn -q "Select * from Data" -rows 50 -R NO_DATA
esscs dimbuild -a Sample -db Basic -CRF /users/weblogic/Dim_Market.rul -CF /shared/Market.txt -R ALL_DATA -F

You can also load dimensions using Cube Designer, Jobs in the Essbase web interface or REST API, or import dimensions in MaxL.

Download: Get Cube Files

The download CLI command for Essbase downloads cube artifacts from an instance of Essbase to a local directory.

You may need to download text files, rule files, or calculation script files from a cube, so you can work on them or upload them to another cube. To download cube artifacts, you need at least Database Update permission.

Syntax

download [-verbose] -file filename[ | -catalogfile catalogFile] [-application appname [-db cubename]] [-localdirectory path] [-overwrite] [-nocompression]
Option Abbreviation Description
-verbose -v Show extended descriptions
-file -f Name of file to download
-application -a Optional. Application name. If not provided, artifacts are downloaded from your user home directory.
-db -d Optional. Database (cube) name
-catalogfile -CF File in the file catalog. You can use this option in place of -file.
-localdirectory -ld Optional. A local directory path
-overwrite -o Optional. Overwrite existing file
-nocompression -nc Optional. Disable compression of data transfer

Examples

esscs download -v -f Product003.rul -a Sample -d Basic -ld c:/temp -o 
esscs download -f Acli.rul -ld c:/temp -o
esscs download -CF /shared/Acli.rul -ld c:/temp -o

You can also manage files in Cube Designer, the Essbase web interface, or REST API.

Help: Display Command Syntax

The help CLI command for Essbase displays command-level help in the console or terminal.

Syntax

[command] -help | -h

Examples

esscs -help
esscs -h
esscs dataload -help

LcmExport: Back Up Cube Files

The lcmexport CLI command for Essbase backs up applications and cube artifacts to a Lifecycle Management (LCM) .zip file, which it downloads to your local machine. To run this command, you need at least Application Manager permission.

Syntax

lcmExport [-verbose] -application appname|-allApp -zipfilename filename [-localDirectory path][-threads threadscount][-skipdata][-overwrite][-generateartifactlist][-include-server-level][-cube][-exportdata][-filetype][-exportpartitions][-exportfilters]
Option Abbreviation Description
-verbose -v Optional. Show extended descriptions.
-application -a Name of application to back up.
-allApp -aa Optional (and case-sensitive). If used instead of -application, exports all applications to a single zip file. lcmimport can accept single-application zip files or multiple-application zip files.
-zipfilename -z Optional. Name of compressed file to hold backup files.
-localdirectory -ld Optional. A local directory path. If not specified, the zip is saved in <Application Directory>/catalog/users/<user_name> on the Essbase server.
-threads -T Optional. Number of threads to spawn if using parallel export. Minimum: 10
-skipdata -skip Optional. Do not include data in the backup.
-overwrite -o Optional. Overwrite existing backup file.
-generateartifactlist -gal Optional. Generate a text file containing a complete list of the exported artifacts. You can use this text file to manage the import of artifacts. For example, you can rearrange the order of artifacts in the list to control the order in which they are imported. You can skip importing some artifacts by removing or commenting out items in the list.
-include-server-level -isl Optional. Include globally defined connections and Datasources as part of the export.
-cube -c Optional. Export a single cube. This option can be specified along with the options to export only: data, files of certain types, partitions, or filters.
-exportdata -d Optional. Only export data.
-filetype -ft

Optional. Only export files of the specified type. Supported file types include OTL (outline), TXT (text), RUL (rule), CSC (calc script), DTR (drill through report definition), and Excel (only .xls files are exported. No .xlsx files are exported).

Examples:

esscs lcmexport -a sample -z sampleXLSOnly.zip -v -ft excel
esscs lcmexport -a sample -z sampleTXTOnly.zip -v -ft txt
-exportpartitions -ep

Optional. Only export partition definitions.

Lifecycle Management (LCM) import operations (and Migration Utility import) are not supported for migration of federated partitions. Federated partitions must be recreated manually on the target.
-exportfilters -ef Optional. Only export security filters.

Notes

This command, like other CLI commands, can be used from outside the Essbase machine, whereas the LCM utility must be run on the Essbase machine.

Example

esscs lcmExport -v -a Sample -z Sample.zip -ld c:/temp -skip -o -gal -isl

Windows Script Example

The following Windows script, lcmexportall.bat, exports all applications to the current local directory from which CLI was called. 

set ESSCLI_ID=%USERNAME%_%random%
@echo on
echo Login to Essbase
call esscs login -u myusername -p mYpa55w0rD -url https://myserver.example.com:9000/essbase
echo Export all apps and download to this directory
call esscs lcmexport -aa -z allapps.zip
echo Log out of Essbase
call esscs logout
@echo off

LcmImport: Restore Cube Files

The lcmimport CLI command for Essbase restores cube artifacts from a Lifecycle Management (LCM) .zip file. To run this command, you must be the power user who created the application, or a service administrator.

Syntax

lcmImport [-verbose] -zipfilename filename [-overwrite] [-targetappName targetApplicationName] [-artifactlist artifactList]
Option Abbreviation Description
-verbose -v Optional. Show extended descriptions
-zipfilename -z Name of compressed file containing backup files
-overwrite -o Optional. Recreate the target application.
-targetappName -ta Optional. Target application name, if you want it to be different from the source name.
-artifactlist -al Optional. Name of the file containing the list of artifacts to import. This file can be generated from lcmexport.

To skip artifacts, comment out or delete entries from the list. For example, to skip importing audit records, comment out that line, as shown:

# ------------IMPORT-----------------
import @Provisions
import @Databases/Basic
#import @Databases/Basic/Audit
import @Databases/Basic/Text_files
import @Databases/Basic/Xml_files
import @Databases/Basic/Calc_scripts
import @Databases/Basic/Open_XML_Excel_files
import @Databases/Basic/ScenarioManagement
import @Databases/Basic/Provisions
import @Databases/Basic/Rule_files

To control import order, rearrange the import entries in the text file.

If –overwrite is used, the import operation deletes and recreates the entire application, importing only the artifacts present in the list. If –overwrite is not used, the import operation includes the artifacts specified in the list, without impacting any other artifacts already present in the target application.

Notes

  • This command, like other CLI commands, can be used from outside the Essbase machine, whereas the LCM utility must be run within the Essbase machine.

  • After the LCM import completes, you may need to take further action to restore migrated connections to external sources. To do this, open the connection and enter the password.

  • When partitions exist between cubes being migrated, you must import the data source before the data target. Otherwise, partition definitions may not be restored.

    Lifecycle Management (LCM) import operations (and Migration Utility import) are not supported for migration of federated partitions. Federated partitions must be recreated manually on the target.

  • LCM Import does not migrate location alias credentials. You must replace your location alias credentials, either by recreating location aliases using MaxL, or by editing the location alias credentials in the XML exported by LCM Export.

Example

esscs lcmImport -z C:/Sample/Sample.zip -o -al C:/Sample/Sample.txt

Listapp: Display Applications

The listapp CLI command lists applications that you have access to on this instance of Essbase.

Syntax

listapp [-verbose] [-details]
Option Abbreviation Description
-verbose -v Optional. Show extended descriptions
-details -dtl Optional. Display more details in the output (application type and current status).

Example

esscs listapp -v -dtl

Listdb: Display Cubes

The listdb CLI command lists databases that you have access to within a specified Essbase application.

Syntax

listdb [-verbose] -application applicationName [details]
Option Abbreviation Description
-verbose -v Optional. Show extended descriptions
-application -a Application name
-details -dtl Optional. Display status details in the output

Example

esscs listdb -v -a Sample -dtl

Listfiles: Display Files

The listfiles CLI command lists cube artifacts that exist on an instance of Essbase.

Cube artifacts may include data files, workbooks, rule files, calculation script files, or other artifacts. Cube artifacts include any files that are needed to perform actions on applications and cubes.

To list files for a cube, you need at least Database Access permission for the application. No special permissions are required to list files from your user directory.

Syntax

listfiles [-verbose] [-type filetype] [-application appname [-db cubename] | -catalogpath catalogPath]
Option Abbreviation Description
-verbose -v Optional. Show extended descriptions
-type -t Optional. File extension/type to display, not including the period.

Supported file types are:

  • .csc (calculation scripts)
  • .rul (rule files)
  • .txt (text files)
  • .msh (MaxL scripts)
  • .xls, .xlsx (Excel workbooks)
  • .xlsm (macro-enabled Excel workbooks)
  • .xml (XML files)
  • .zip (compressed zip files)
  • .csv (comma-separated files)
-application -a Optional. Application name. If not provided, files from your user home directory are displayed.
-db -d Optional. Database (cube) name
-catalogpath -CP Optional. Catalog path to the filename. Can be used instead of -a [-d] to specify the catalog location of the file(s).

Examples

esscs listfiles -t rul -a Sample -d Basic 
esscs listfiles -CP "/shared"

You can also manage files in Cube Designer, the Essbase web interface, or REST API.

Listfilters: View Security Filters

The listfilters CLI command displays a list of Essbase security filters. You need at least Database Manager permission on the application to see filters for any cubes in the application.

Syntax

listfilters [-verbose] -application appname -db cubename
Option Abbreviation Description
-verbose -v Optional. Show extended descriptions
-application -a Application name
-db -d Database (cube) name

Example

esscs listfilters -v -a Sample -d Basic

Listlocks: View Locks

The listlocks CLI command for Essbase displays any locked data blocks or cube-related objects. To run this command, you need at least Database Access permission on the application.

Syntax

listlocks [-verbose] -application appname -db cubename [-object]
Option Abbreviation Description
-verbose -v Optional. Show extended descriptions
-application -a Application name
-db -d Database (cube) name
-object -obj Optional. Display locked files/artifacts.

Example

esscs listlocks -v -a Sample -d Basic -obj

Listvariables: Display Substitution Variables

The listvariables CLI command for Essbase lists substitution variables defined at the cube, application, or global scope. You need at least Database Access permission to see variables for a cube, Application Manager role to see variables for an application, and Service Administrator role to see global variables.

Syntax

listvariables [-verbose] [-application application [-db database]]
Option Abbreviation Description
-verbose -v Show extended descriptions.
-application -a Optional. Application name.
-database -db Optional. Database (cube) name.

Examples

Cube level

esscs listvariables -a Sample -db Basic

Application level

esscs listvariables -a Sample

Global level

esscs listvariables

Setpassword: Store CLI Credentials

The setpassword CLI command for Essbase stores a password associated with your client/user combination. In subsequent sessions, you can log in without entering a password.

Syntax

 setpassword [-verbose] -essbaseurl URL -user userName
Option Abbreviation Description
-verbose -v Optional. Show extended descriptions
-essbaseurl -url Address of an instance of Essbase
-user -u Your user name

Notes

After migrating to Release 21.4 or higher, you must reset any stored passwords that were saved using this command in a previous release.

Example

esscs setpassword -url https://myEssbase-test-myDomain.analytics.us2.example.com/essbase -user rschmidt

Start: Start an Application or Cube

The start CLI command starts an Essbase application or cube, loading it into memory. To run this command, you need at least Database Access permission on the application.

Syntax

start [-verbose] -application appname [-db cubename]
Option Abbreviation Description
-verbose -v Optional. Show extended descriptions
-application -a Application name
-db -d Optional. Database (cube) name

Example

esscs start -v -a Sample -d Basic

Stop: Stop an Application or Cube

The stop CLI command stops an Essbase application or cube. To run this command, you need at least Database Access permission on the application.

Syntax

stop [-verbose] -application appname [-db cubename]
Option Abbreviation Description
-verbose -v Optional. Show extended descriptions
-application -a Application name
-db -d Optional. Database (cube) name

Example

esscs stop -v -a Sample -d Basic

Unsetpassword: Remove Stored CLI Credentials

The unsetpassword CLI command for Essbase removes stored login credentials associated with your client/user combination, reversing the effect of setpassword.

Syntax

unsetpassword [-verbose] -essbaseurl URL -user userName
Option Abbreviation Description
-verbose -v Show extended descriptions
-essbaseurl -url Address of an instance of Essbase
-user -u The user whose password to unset

Example

esscs unsetpassword -url https://myEssbase-test-myDomain.analytics.us2.example.com/essbase -u user1

Upload: Add Cube Files

The upload CLI command uploads cube artifacts from a local directory to an instance of Essbase.

To perform tasks such as data loads, dimension builds, calculations, or other operations, you may need to upload data files, rule files, calculation script files, or other artifacts to the cube directory. You can also upload the artifacts to your user directory.

To upload files to a cube, you need at least Database Manager permission. No special permissions are required to upload to your user directory.

Note:

You can enable antivirus scanning in the Essbase web interface so that files are scanned for viruses before they are uploaded to the server.

Syntax

upload [-verbose] -file filename [-application appname [-db cubename] | -catalogpath catalogPath] [-overwrite] [-nocompression][-compressionalgorithm]
Option Abbreviation Description
-verbose -v Optional. Show extended descriptions
-file -f Name of file to upload

Note:

File extensions must be lower case. For example, filename.txt.
-application -a Optional. Application name. If not provided, files are uploaded to your user directory, or to the catalog path specified in -CP.
-db -d Optional. Database (cube) name. Requires -a.
-catalogpath -CP Optional. Catalog path to the filename. Can be used instead of -a [-d] to specify the catalog location of the file.
-overwrite -o Optional. Overwrite existing file
-nocompression -nc Optional. Disable compression of data transfer
-compressionalgorithm -ca Optional. Available if -nc is not used. Defines which compression algorithm to use for data transfer. Possible choices: gzip or lz4.

  • gzip—Default if compression is used. Provides smaller data transfer with slower calculation.

  • lz4—Provides faster calculation with a slower data transfer.

Usage examples:

-ca gzip
-ca lz4

Examples

esscs upload -v -f c:/temp/Maxl01.msh -a Sample -d Basic -o -ca lz4
esscs upload -f C:/temp/Act1.rul -CP /shared

You can also manage files in Cube Designer, the Essbase web interface, or REST API.

Version: Display API Version

The version CLI command gets the version of the REST API that is associated with this instance of Essbase.

Syntax

version

Example

esscs version