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.