CLI 命令參照

您必須登入後才能對 Essbase 發出任何其他 CLI 命令。如果需要使用安全連線，URL 必須以 https 為開頭。

您可以透過以下方式使用 CLI 進行認證：

• 使用一次 setpassword，儲存從屬端/使用者組合的密碼。在後續的階段作業中，您可以使用 login 命令，而且系統不會提示您輸入密碼。
• 在 login 命令使用 -user 和 -password 選項 (注意：密碼會在 shell 視窗中以純文字形式顯示)。
• 只在 login 命令使用 -user 選項。系統會提示您輸入密碼，但不會顯示出來。

若您為 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 是 Identity Cloud Service 管理員，此管理員已於 Oracle Cloud Infrastructure 進行 Essbase 堆疊部署期間被設為初始 Essbase 管理員。此範例並未輸入密碼，因此系統接下來會提示管理員提供密碼。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 中的執行計算來執行計算命令檔。

語法

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 檔案 (請參閱從遠端資料庫進行串流處理以建置維度及載入資料)。

語法

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

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

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

如果您在外部資料來源與 Essbase 之間設有網路連線，那麼在 Essbase Web 介面中定義應用程式層級或全域連線與資料來源，會是最有效率的方式。這些定義可幫助您輕鬆地從外部來源「提取」資料。如果 Essbase 與外部資料來源之間沒有網路連線，您就要先使用此命令建立本機連線，然後發出 dataload 或 dimbuild 命令搭配串流選項，使用 CLI 串流處理資料載入或維度建置。

備註

移轉至 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 中的匯入資料來載入資料。

語法

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 中的匯入維度來載入維度。

您可能需要從一個立方體下載文字檔、規則檔或計算命令檔檔案，然後對這些檔案做處理或將它們上傳到另一個立方體。若要下載立方體使用者自建物件，您必須至少具備「資料庫更新」權限。

語法

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]

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] [-artifactlist artifactList]

# ------------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 匯入完成之後，您可能需要採取進一步動作來回復外部來源的已移轉連線。若要這樣做，請開啟連線並輸入密碼。

• 如果分割區存在於要移轉的立方體之間，必須先匯入資料來源，再匯入資料目標。否則，分割區定義可能無法回復。

  不支援使用生命週期管理 (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