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

Login/Logout: CLI認証

Essbaseのlogin CLIコマンドは、CLIを使用できるようにEssbaseに対する認証を行います。

Essbaseに他のCLIコマンドを発行する前に、ログインする必要があります。保護された接続が必要な場合、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]

オプション	短縮形	説明
-verbose	-v	詳細説明を表示します
-essbaseurl	-url	Essbaseのインスタンスのアドレス
-user	-u	ユーザー名
-password	-p	オプション。ユーザーのパスワード。あるいは、setpasswordを使用してパスワードを設定できます。スクリプトからloginコマンドを発行し、パスワードに特殊文字が含まれる場合は、二重引用符で囲みます(たとえば、`"aNb3^5%9$!"`)。 Essbaseパスワード内での`$` (ドル記号)文字の使用は、Linux環境でのログインではサポートされていません。

例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

Calc: 計算スクリプトの実行

Essbaseのcalc CLIコマンドは、キューブで計算スクリプトを実行します。このコマンドを実行するには、少なくとも「データベースの更新」権限および計算スクリプトへのプロビジョニングされたアクセス権が必要です。

計算スクリプトを実行するには、最初にスクリプトを.cscファイルとしてキューブ・ディレクトリにアップロードする必要があります。CLIを使用してファイルをアップロードできます。Upload: キューブ・ファイルの追加を参照してください。

構文

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

オプション	短縮形	説明
-verbose	-v	詳細説明を表示します
-application	-a	アプリケーション名
-db	-d	データベース(キューブ)名
-script	-s	計算スクリプトの名前。`.csc`のファイル拡張子を付ける必要があります。フル・パスを指定する必要はありません。ファイルは関連するキューブ・ディレクトリ内にあるとみなされます。

例

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

計算スクリプトは、キューブ・デザイナまたはSmart Viewの「計算」オプション、Essbase Webインタフェースの「ジョブ」またはREST API、MaxLのexecute calculationを使用して実行することも可能です。

Clear: キューブからのデータの除去

Essbaseのclear CLIコマンドは、キューブからデータをクリアします。このコマンドを使用するには、少なくとも「データベースの更新」権限が必要です。

構文

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

オプション	短縮形	説明
-verbose	-v	オプション。詳細説明を表示します
-application	-a	アプリケーション名
-db	-d	データベース(キューブ)名
-option	-O	オプション。クリア対象を指定するキーワードです。省略した場合、デフォルトのオプションはALL_DATAです。ブロック・ストレージ・キューブのオプションは、次のとおりです。 `ALL_DATA`--すべてのデータ、リンク・オブジェクトおよびアウトラインがクリアされます `UPPER_LEVEL`--上位レベルのブロックがクリアされます `NON_INPUT`--非入力ブロックがクリアされます集約ストレージ・キューブのオプションは、次のとおりです。 `ALL_DATA`--すべてのデータ、リンク・オブジェクトおよびアウトラインがクリアされます `ALL_AGGREGATIONS` --すべての集計データがクリアされます `PARTIAL_DATA` --指定したデータ・リージョンのみがクリアされます。-regionspecを指定して使用します
-regionspec	-rs	クリアするリージョンを指定するMDX式

例

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

データは、キューブ・デザイナの「データのロード」オプション、Essbase Webインタフェースの「ジョブ」やREST API、またはMaxLのalter database DBS-NAME resetを使用してクリアすることもできます。

Createlocalconnection: JDBC接続の保存

Essbaseのcreatelocalconnection CLIコマンドは、JDBC接続を作成してローカルに格納します。このコマンドを使用するには、「サービス管理者」または「パワー・ユーザー」ロールが必要です。

説明

CLIのdataloadまたはdimbuildコマンドをストリーミング・オプション付きで使用するには、サービス管理者が事前にこのコマンドを使用してローカル接続を作成し、保存しておく必要があります。さらに、環境変数EXTERNAL_CLASSPATHがデータベース・ドライバの.jarファイルを指すように設定する必要があります(リモート・データベースからのストリーミングによるディメンションの構築およびデータのロードに関する項を参照してください)。

構文

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

オプション	短縮形	説明
-verbose	-v	詳細説明を表示します
-name	-N	接続名
-connectionstring	-cs	JDBC接続文字列。形式には、サービス名を使用できます: `jdbc:oracle:thin:@host:port/service_name` または、次のようにSIDを使用します: `jdbc:oracle:thin:@host:port:SID` 前述の構文形式は、Oracle Databaseに当てはまります。他のプロバイダを使用する場合の接続文字列構文のわずかな違いについて、「例」の項を参照してください。
-user	-u	ユーザー名
-driver	-D	JDBCドライバ。指定しなかった場合は、Oracle Databaseがデフォルトで、`oracle.jdbc.driver.OracleDriver`とみなされます。
-password	-p	パスワード(オプション)

データの外部ソースとEssbaseの間にネットワーク接続がある場合、最も効果的なのは、Essbase Webインタフェースで、アプリケーションレベルまたはグローバルの接続とデータソースを定義することです。これらの定義により、外部ソースからデータを簡単にプルできるようになります。Essbaseとデータの外部ソースの間にネットワーク接続がない場合は、CLIを使用し、まずこのコマンドを使用してローカル接続を作成し、ストリーム・オプションを指定してdataloadまたはdimbuildコマンドを発行し、データ・ロードまたはディメンション構築をストリームできます。

ノート

リリース21.4以上に移行した後、サービス管理者は、以前のリリースでこのコマンドを使用して作成した保存済ローカル接続を再作成する必要があります。

例