CLI-Befehlsreferenz

Sie müssen sich erst anmelden, bevor Sie andere CLI-Befehle für Essbase ausgeben können. Wenn eine sichere Verbindung erforderlich ist, muss die URL mit https anfangen.

Sie können sich wie folgt mit der CLI authentifizieren:

• Verwenden Sie setpassword einmal, um das Kennwort für Ihre Client-/Benutzerkombination zu speichern. In nachfolgenden Sessions können Sie den login-Befehl verwenden, ohne ein Kennwort angeben zu müssen.
• Verwenden Sie die Optionen "-user" und "-password" mit dem login-Befehl. (Achtung: Das Kennwort wird als Klartext im Shellfenster angezeigt.)
• Verwenden Sie nur die Option "-user" mit dem login-Befehl. Sie werden zur Eingabe des Kennwortes aufgefordert (dieses ist ausgeblendet).

Wenn Sie ein föderierter SSO-Benutzer in Oracle Identity Cloud Service sind, wird die Anmeldung mit MaxL oder mit der CLI nicht unterstützt. Für eine föderierte SSO-Anmeldung ist ein Browserfenster erforderlich. Erstellen Sie einen nativen Identity-Cloud-Servicebenutzer, und verwenden Sie bei der Anmeldung mit MaxL oder der CLI stattdessen diesen Benutzer.

Syntax (login)

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

Beispiel 1 (login)

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

Beispiel 2 (login)

Im folgenden Beispiel handelt es sich bei dem Benutzer, der sich anmeldet (admin1@example.com), um einen Identity-Cloud-Serviceadministrator. Dieser wurde beim Deployment des Essbase-Stacks in Oracle Cloud Infrastructure als anfänglicher Essbase-Administrator festgelegt. Da das Kennwort in diesem Beispiel nicht eingegeben wurde, wird der Administrator als Nächstes zu dessen Eingabe aufgefordert. Die URL entspricht der Angabe essbase_url aus den Jobausgaben, die aus dem Stack-Deployment resultieren.

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

Syntax (logout)

logout

Beispiel (logout)

esscs logout

Bevor Sie Berechnungsskripte ausführen können, müssen Sie die Skripte zunächst als CSC-Dateien in das Cube-Verzeichnis hochladen. Mit der CLI können Sie Dateien hochladen. Siehe Upload: Cube-Dateien hinzufügen.

Syntax

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

Beispiel

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

Sie können Berechnungsskripte auch mit der Option "Berechnen" in Cube Designer oder Smart View, mit der Option "Jobs" in der Essbase-Weboberfläche oder REST-API oder mit der Anweisung execute calculation in MaxL ausführen.

Syntax

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

Beispiel

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

Sie können Daten auch mit der Option "Daten laden" in Cube Designer, über "Jobs" in der Essbase-Weboberfläche oder REST-API oder mit der Anweisung alter database DBS-NAME reset in MaxL löschen.

Beschreibung

Ein Serviceadministrator muss mit diesem Befehl die lokale Verbindung erstellen und speichern, bevor der CLI-Befehl dataload oder dimbuild mit der Streamingoption verwendet werden kann. Sie müssen auch eine EXTERNAL_CLASSPATH-Umgebungsvariable so festlegen, dass sie auf die JAR-Datei für Ihren Datenbanktreiber verweist (siehe Dimensionen erstellen und Daten per Streaming aus einer Remotedatenbank laden).

Syntax

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

Wenn eine Netzwerkverbindung zwischen einer externen Datenquelle und Essbase besteht, ist es am effizientesten, Verbindungen auf Anwendungsebene oder globale Verbindungen und Datenquellen in der Essbase-Weboberfläche zu definieren. Über diese Definitionen können Sie Daten einfach per "Pull" aus der externen Quelle abrufen. Wenn keine Netzwerkverbindung zwischen Essbase und der externen Datenquelle besteht, können Sie Dataloads oder Dimensionserstellungen mit der CLI streamen, indem Sie zunächst mit diesem Befehl eine lokale Verbindung herstellen und anschließend den Befehl "dataload" oder "dimbuild" mit der Option "stream" ausgeben.

Hinweise

Nach der Migration zu Release 21.4 oder höher muss der Serviceadministrator alle gespeicherten lokalen Verbindungen neu erstellen, die in einem früheren Release mit diesem Befehl erstellt wurden.

Beispiele

Für diesen Befehl ist eines der folgenden Optionssets erforderlich:

• Datendatei und optionale Regeldatei

• Regeldatei mit Benutzername und Kennwort

• Streamoption, die eine gespeicherte lokale Verbindung referenziert

Die Quelldatenbank muss im Clientnetzwerk zugänglich sein, da nicht alle Datenbanktreiber mit Java-Proxys arbeiten können.

Um Daten zu laden, müssen Sie zunächst die Dataload- und die Regeldateien in das Cube-Verzeichnis hochladen. Mit der CLI können Sie Dateien hochladen. Siehe Upload: Cube-Dateien hinzufügen.

Syntax

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]

Beispiele

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"

Sie können Daten auch mit Cube Designer, über "Jobs" in der Essbase-Weboberfläche oder REST-API oder mit der Anweisung import data in MaxL laden.

Syntax

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

Beispiele

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

esscs deletefile -CF /shared/Data.txt

Sie können Dateien auch in Cube Designer, der Essbase-Weboberfläche oder der REST-API verwalten.

Syntax

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

Beispiele

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

Sie können Cubes auch mit Cube Designer oder mit der Option "Importieren" im Abschnitt Anwendungen der Essbase-Weboberfläche bereitstellen.

Bevor Sie Dimensionen laden können, müssen Sie zunächst die Dimensionserstellungs- und Regeldateien in Essbase hochladen. Mit der CLI können Sie Dateien hochladen. Siehe Upload: Cube-Dateien hinzufügen.

Syntax

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]

Beispiele

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

Sie können Dimensionen auch mit Cube Designer, über "Jobs" in der Essbase-Weboberfläche oder REST-API oder mit der Anweisung import dimensions in MaxL laden.

Möglicherweise müssen Sie Textdateien, Regeldateien oder Berechnungsskriptdateien aus einem Cube herunterladen, damit Sie diese bearbeiten oder in einen anderen Cube hochladen können. Um Cube-Artefakte herunterladen zu können, benötigen Sie mindestens die Berechtigung "Datenbankaktualisierung".

Syntax

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

Beispiele

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

Sie können Dateien auch in Cube Designer, der Essbase-Weboberfläche oder der REST-API verwalten.

Syntax

[command] -help | -h

Beispiele

esscs -help

esscs -h

esscs dataload -help

Syntax

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

Hinweise

Dieser Befehl kann wie andere CLI-Befehle auch von außerhalb des Essbase-Rechners verwendet werden, während das LCM-Utility auf dem Essbase-Rechner ausgeführt werden muss.

Beispiel

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

Beispiel eines Windows-Skripts

Das folgende Windows-Skript lcmexportall.bat exportiert alle Anwendungen in das aktuelle lokale Verzeichnis, aus dem die CLI aufgerufen wurde.

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

Syntax

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

Hinweise

• Dieser Befehl kann wie andere CLI-Befehle auch von außerhalb des Essbase-Rechners verwendet werden, während das LCM-Utility auf dem Essbase-Rechner ausgeführt werden muss.

• Nach Abschluss des LCM-Importvorgangs müssen Sie möglicherweise weitere Maßnahmen ergreifen, um migrierte Verbindungen zu externen Quellen wiederherzustellen. Öffnen Sie hierzu die Verbindung, und geben Sie das Kennwort ein.

• Wenn Partitionen zwischen den zu migrierenden Cubes vorhanden sind, müssen Sie die Datenquelle vor dem Datenziel importieren. Andernfalls könnten Partitionsdefinitionen nicht wiederhergestellt werden.

  Lifecycle-Management-(LCM-)Importvorgänge (und Migrationsutilityimport) werden bei der Migration von föderierten Partitionen nicht unterstützt. Föderierte Partitionen müssen auf dem Ziel manuell neu erstellt werden.

• Mit LCM Import werden keine Speicherortalias-Zugangsdaten migriert. Sie müssen die Speicherortalias-Zugangsdaten ersetzen, entweder durch Neuerstellung der Speicherortaliasnamen mit MaxL oder durch Bearbeiten der Speicherortalias-Zugangsdaten in der von LCM Export exportierten XML.

Beispiel

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

Syntax

listapp [-verbose] [-details]

Beispiel

esscs listapp -v -dtl

Syntax

listdb [-verbose] -application applicationName [details]

Beispiel

esscs listdb -v -a Sample -dtl

Cube-Artefakte können Datendateien, Arbeitsmappen, Regeldateien, Berechnungsskriptdateien oder andere Artefakte umfassen. Zu Cube-Artefakten gehören alle Dateien, die zur Ausführung von Aktionen mit Anwendungen und Cubes erforderlich sind.

Zum Auflisten der Dateien für einen Cube benötigen Sie mindestens die Berechtigung "Datenbankzugriff" für die Anwendung. Zum Auflisten von Dateien in Ihrem Benutzerverzeichnis sind keine speziellen Berechtigungen erforderlich.

Syntax

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

Beispiele

esscs listfiles -t rul -a Sample -d Basic 

esscs listfiles -CP "/shared"

Sie können Dateien auch in Cube Designer, der Essbase-Weboberfläche oder der REST-API verwalten.

Syntax

listfilters [-verbose] -application appname -db cubename 

Beispiel

esscs listfilters -v -a Sample -d Basic 

Syntax

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

Beispiel

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

Syntax

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

Beispiele

Cube-Ebene

esscs listvariables -a Sample -db Basic

Anwendungsebene

esscs listvariables -a Sample

Globale Ebene

esscs listvariables

Syntax

 setpassword [-verbose] -essbaseurl URL -user userName

Hinweise

Nach der Migration zu Release 21.4 oder höher müssen Sie alle gespeicherten Kennwörter zurücksetzen, die in einem früheren Release mit diesem Befehl gespeichert wurden.

Beispiel

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

Syntax

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

Beispiel

esscs start -v -a Sample -d Basic

Syntax

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

Beispiel

esscs stop -v -a Sample -d Basic 

Syntax

unsetpassword [-verbose] -essbaseurl URL -user userName

Beispiel

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

Zum Ausführen von Aufgaben wie Dataloads, Dimensionserstellungen, Berechnungen oder anderen Vorgängen müssen Sie möglicherweise Datendateien, Regeldateien, Berechnungsskriptdateien oder andere Artefakte in das Cube-Verzeichnis hochladen. Sie können die Artefakte auch in Ihr Benutzerverzeichnis hochladen.

Zum Hochladen von Dateien in einen Cube benötigen Sie mindestens die Berechtigung "Datenbankmanager". Zum Hochladen in Ihr Benutzerverzeichnis sind keine speziellen Berechtigungen erforderlich.

Syntax

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

-ca gzip

-ca lz4

Beispiele

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

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

Sie können Dateien auch in Cube Designer, der Essbase-Weboberfläche oder der REST-API verwalten.

Syntax

version

Beispiel

esscs version