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][-restEncryPassword]| 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. |
| -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: |
| -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. |
| -restEncryPassword | -encryPwd |
If the application is encrypted, a password to protect the encrypted application during migration. The password must be between 6-15 characters, and should not contain any of the following special characters: Caution: If this password is forgotten, there is no way to retrieve it, and the application cannot be imported. |
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 -islWindows 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