CLIコマンド・リファレンス

他のCLIコマンドをEssbaseに発行する前に、ログインする必要があります。保護された接続が必要な場合、URLはhttpsで始める必要があります。

CLIを使用して、次の方法で認証できます。

• クライアント/ユーザーの組合せに対してパスワードを格納するために、setpasswordを一度使用します。後続のセッションでは、パスワードの入力を求められずにloginコマンドを使用できます。
• loginコマンドで-userおよび-passwordオプションを使用します(注意: シェル・ウィンドウにクリアテキストとしてパスワードが表示されます)。
• 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は、Oracle Cloud InfrastructureでのEssbaseのスタック・デプロイメント中に、初期の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ファイルを指すように設定する必要があります(リモート・データベースからのストリーミングによるディメンションの構築およびデータのロードに関する項を参照してください)。

構文

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を使用し、まずこのコマンドを使用してローカル接続を作成し、ストリーム・オプションを指定して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のインポートが完了したら、外部ソースへの移行された接続をリストアするための処理がさらに必要になる場合があります。これを行うには、接続をオープンし、パスワードを入力します。

• 移行されるキューブ間にパーティションが存在する場合は、データ・ターゲットの前にデータ・ソースをインポートする必要があります。そうしないと、パーティション定義がリストアされない可能性があります。

  ライフサイクル管理(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