CLI 命令参考

您必须先登录，然后才能向 Essbase 发出任何其他 CLI 命令。如果需要安全连接，则 URL 必须以 https 开头。

使用 CLI，可以按如下方式进行验证：

• 使用 setpassword 一次，即可存储与您的客户端/用户组合相关的密码。在后续会话中，使用 login 命令时不会提示您输入密码。
• 使用带有 -user 和 -password 选项的 login 命令（警告：密码以明文形式出现在 shell 窗口中）。
• 使用仅带有 -user 选项的 login 命令。将提示您输入密码，而且密码将被隐藏。

如果您是 Oracle Identity Cloud Service 中的联合 SSO 用户，则不支持使用 MaxL 或 CLI 进行登录。若进行联合 SSO 登录，需要使用浏览器窗口。创建本机 Identity Cloud Service 用户，并改为使用此用户通过 MaxL 或 CLI 登录。

语法 (login)

login [-verbose] -essbaseurl https://instance-name.example.com/essbase -user username [-password password] 

示例 1 (login)

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

示例 2 (login)

在下面的示例中，登录用户 admin1@example.com 是在将 Essbase 堆栈部署到 Oracle Cloud Infrastructure 的过程中，设置为初始 Essbase 管理员的 Identity Cloud Service 管理员。由于在此示例中未输入密码，因此，系统将在后面提示管理员提供密码。URL 是堆栈部署所生成的作业输出中的 essbase_url。

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

语法 (logout)

logout

示例 (logout)

esscs logout

要运行计算脚本，必须先以 .csc 文件格式将脚本上载到多维数据集目录。可以使用 CLI 上载文件。请参见 Upload：添加多维数据集文件。

语法

calc [-verbose] -application appname -db cubename -script scriptfilename

示例

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

还可以使用以下方式运行计算脚本：多维数据集设计器或 Smart View 中的“计算”选项、Essbase Web 界面中的“作业”或 REST API，或 MaxL 中的 execute calculation。

语法

clear [-verbose] -application appname -db cubename [-option clearOption[-regionspec regionSpec]]

示例

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

还可以使用以下方式清除数据：多维数据集设计器中的“加载数据”选项、Essbase Web 界面中的“作业”或 REST API，或 MaxL 中的 alter database DBS-NAME reset。

说明

服务管理员必须先使用此命令创建和保存本地连接，其他人才能使用带有流式选项的 CLI dataload 或 dimbuild 命令。您还必须设置环境变量 EXTERNAL_CLASSPATH，以指向数据库驱动程序的 .jar 文件（请参见 "Build Dimensions and Load Data by Streaming from a Remote Database"）。

语法

createLocalConnection [-verbose] -name streamConnection -connectionstring  connectionString -user userName [-driver jdbcDriver] [-password password]

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

jdbc:oracle:thin:@host:port:SID

如果在外部数据源和 Essbase 之间有网络连接，最有效的方式是在 Essbase Web 界面中定义应用程序级别或全局连接和数据源。这些定义有助于您轻松地从外部源“拉取”数据。如果在 Essbase 和外部数据源之间没有网络连接，可以使用 CLI 通过流式传输完成数据加载或维构建，方法是首先使用此命令创建本地连接，然后发出带 stream 选项的 dataload 或 dimbuild 命令。

注释

迁移到发行版 21.4 或更高版本后，服务管理员需要重新创建在先前发行版中使用此命令创建的已保存本地连接。

示例

此命令需要以下选项集之一：

• 数据文件和可选的规则文件

• 具有用户名和密码的规则文件

• 引用已保存本地连接的流选项

源数据库应能在客户端网络中访问，因为不是所有数据库驱动程序都能与 Java 代理一起使用。

要加载数据，您必须先将数据加载和规则文件上载到多维数据集目录。可以使用 CLI 上载文件。请参见 Upload：添加多维数据集文件。

语法

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]

示例

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"

还可以使用以下方式加载数据：多维数据集设计器、Essbase Web 界面中的“作业”或 REST API，或 MaxL 中的 import data。

语法

deletefile [-verbose] -file fileName [-application application [-db  database] [| -catalogfile catalogFile]]

示例

esscs deletefile -a Sample -d Basic -f Act1.rul

esscs deletefile -CF /shared/Data.txt

您还可以在多维数据集设计器、Essbase Web 界面或 REST API 中管理文件。

语法

deploy [-verbose] -file fileName [-application application [-database database] | -catalogfile catalogFile] [-restructureoption restructureOption] [-loaddata] [-recreateapplication] [-createfiles] [-executescript]

示例

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

还可以使用多维数据集设计器部署多维数据集，或通过使用 Essbase Web 界面的应用程序部分中的“导入”选项进行部署。

要加载维，您必须先将维构建和规则文件上载到 Essbase。可以使用 CLI 上载文件。请参见 Upload：添加多维数据集文件。

语法

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]

示例

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

还可以使用以下方式加载维：多维数据集设计器、Essbase Web 界面中的“作业”或 REST API，或 MaxL 中的 import dimensions。

您可能需要从多维数据集下载文本文件、规则文件或计算脚本文件，以便使用它们或者将它们上载到另一个多维数据集。要下载多维数据集构件，您至少需要具有“数据库更新”权限。

语法

download [-verbose] -file filename[ | -catalogfile catalogFile] [-application appname [-db cubename]] [-localdirectory path] [-overwrite] [-nocompression]

示例

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

您还可以在多维数据集设计器、Essbase Web 界面或 REST API 中管理文件。

语法

[command] -help | -h

示例

esscs -help

esscs -h

esscs dataload -help

语法

lcmExport [-verbose] -application appname|-allApp -zipfilename filename [-localDirectory path][-threads threadscount][-skipdata][-overwrite][-generateartifactlist][-include-server-level][-cube][-exportdata][-filetype][-exportpartitions][-exportfilters][-restEncryPassword]

esscs lcmexport -a sample -z sampleXLSOnly.zip -v -ft excel

esscs lcmexport -a sample -z sampleTXTOnly.zip -v -ft txt

注释

此命令与其他 CLI 命令一样，可以从 Essbase 计算机外部使用，而 LCM 实用程序必须在 Essbase 计算机上运行。

示例

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

Windows 脚本示例

以下 Windows 脚本 lcmexportall.bat 将所有应用程序导出到调用 CLI 的当前本地目录。

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 [-verbose] -zipfilename filename [-overwrite] [-targetappName targetApplicationName][-include-server-level][-artifactlist artifactList][-restEncryPassword]

# ------------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

注释

• 此命令与其他 CLI 命令一样，可以从 Essbase 计算机外部使用，而 LCM 实用程序必须在 Essbase 计算机上运行。

• 在 LCM 导入完成后，您可能需要执行进一步操作以还原迁移的外部源连接。为此，应打开连接并输入密码。

• 当正迁移的多维数据集之间存在分区时，必须先导入数据源，再导入数据目标。否则，分区定义可能无法还原。

  不支持通过生命周期管理 (Lifecycle Management, LCM) 导入操作（和迁移实用程序导入）迁移联合分区。必须在目标上手动重新创建联合分区。

• LCM 导入不会迁移位置别名身份证明。您必须替换位置别名身份证明，这可以通过以下方法完成：使用 MaxL 重新创建位置别名，或在通过 LCM 导出操作导出的 XML 中编辑位置别名身份证明。

示例

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

语法

listapp [-verbose] [-details]

示例

esscs listapp -v -dtl

语法

listdb [-verbose] -application applicationName [details]

示例

esscs listdb -v -a Sample -dtl

多维数据集构件可能包括数据文件、工作簿、规则文件、计算脚本文件或其他构件。多维数据集构件包括对应用程序和多维数据集执行操作时需要的任何文件。

要列出多维数据集的文件，您至少需要对应用程序具有“数据库访问”权限。无需特殊的权限即可列出您的用户目录中的文件。

语法

listfiles [-verbose] [-type filetype] [-application appname [-db cubename] | -catalogpath catalogPath] 

示例

esscs listfiles -t rul -a Sample -d Basic 

esscs listfiles -CP "/shared"

您还可以在多维数据集设计器、Essbase Web 界面或 REST API 中管理文件。

语法

listfilters [-verbose] -application appname -db cubename 

示例

esscs listfilters -v -a Sample -d Basic 

语法

listlocks [-verbose] -application appname -db cubename [-object] 

示例

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

语法

listvariables [-verbose] [-application application [-db database]]

示例

多维数据集级别

esscs listvariables -a Sample -db Basic

应用程序级别

esscs listvariables -a Sample

全局级别

esscs listvariables

语法

 setpassword [-verbose] -essbaseurl URL -user userName

注释

迁移到发行版 21.4 或更高版本后，必须重置在先前发行版中使用此命令保存的任何存储密码。

示例

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

语法

start [-verbose] -application appname [-db cubename]

示例

esscs start -v -a Sample -d Basic

语法

stop [-verbose] -application appname [-db cubename]

示例

esscs stop -v -a Sample -d Basic 

语法

unsetpassword [-verbose] -essbaseurl URL -user userName

示例

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

要执行数据加载、维构建、计算等任务或其他操作，可能需要将数据文件、规则文件、计算脚本文件或其他构件上载到多维数据集目录。您还可以将构件上载到用户目录。

要将文件上载到多维数据集，您至少需要具有“数据库管理者”权限。无需任何特殊权限即可上载到您的用户目录。

语法

upload [-verbose] -file filename [-application appname [-db cubename] | -catalogpath catalogPath] [-overwrite] [-nocompression][-compressionalgorithm]

-ca gzip

-ca lz4

示例

esscs upload -v -f c:/temp/Maxl01.msh -a Sample -d Basic -o -ca lz4

esscs upload -f C:/temp/Act1.rul -CP /shared

您还可以在多维数据集设计器、Essbase Web 界面或 REST API 中管理文件。

语法

version

示例

esscs version