Reference pro příkazy CLI

Než budete moci zadávat jakékoli další příkazy CLI do Essbase, musíte se přihlásit. Pokud je požadováno zabezpečené připojení, musí adresa URL začínat https.

Pomocí CLI se můžete přihlásit následujícími způsoby:

• Použít příkaz setpassword , pokud chcete uložit heslo pro vaši kombinaci klient/uživatel. V následujících relacích se můžete přihlásit příkazem login, aniž byste museli zadávat heslo.
• Použít příkaz login s parametry -user a -password (pozor: heslo se v přihlašovacím okně zobrazí jako čitelný text).
• Použít příkaz login pouze s parametrem -user. Budete vyzváni k zadání hesla, které zůstane skryté.

Pokud jste uživatel SSO federované ve službě Oracle Identity Cloud Service, přihlášení pomocí MaxL nebo CLI není podporováno. Federované přihlášení SSO vyžaduje okno prohlížeče. Místo toho vytvořte nativního uživatele služby Identity Cloud Service a použijte jej k přihlášení pomocí MaxL nebo CLI.

Syntaxe (přihlášení)

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

Příklad 1 (přihlášení)

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

Příklad 2 (přihlášení)

V následujícím příklad je uživatel, který se přihlašuje, admin1@example.com, správcem služby Identity Cloud Service, který byl ustanoven počátečním správcem aplikace Essbase během nasazování vrstvy Essbase v infrastruktuře Oracle Cloud Infrastructure. Jelikož v tomto příkladu nebylo zadáno heslo, správce o ně bude požádán v dalším kroku. Adresa URL je essbase_url z výstupů úloh vyplývajících z vrstvy nasazení.

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

Syntaxe (odhlášení)

logout

Příklad (odhlášení)

esscs logout

Než budete moci spustit výpočetní skripty, musíte skripty nejprve nahrát jako soubory .csc do adresáře krychle. K odesílání souborů můžete použít nástroj CLI. Prostudujte si téma Nahrání: přidávání souborů krychle.

Syntaxe

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

Příklad

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

Skripty výpočtu lze spustit také prostřednictvím volby Vypočítat v nástroji Cube Designer nebo v modulu Smart View, na stránce Úlohy ve webovém rozhraní Essbase nebo v rozhraní REST API nebo lze spustit výpočet v MaxL.

Syntaxe

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

Příklad

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

Data můžete vymazat rovněž pomocí volby Načíst data v nástroji Cube Designer, na stránce Úlohy ve webovém rozhraní aplikace Essbase nebo v rozhraní REST API, případně můžete změnit obnovu DBS-NAME databáze v MaxL.

Popis

Správce služby musí použít tento příkaz k vytvoření a uložení místního připojení, než bude kdokoli moci použít příkazy rozhraní příkazového řádku dataload nebo dimbuild s možností streamování. Je třeba také nastavit proměnnou prostředí EXTERNAL_CLASSPATH tak, aby ukazovala na soubor .jar vašeho ovladače databáze (viz Sestavování dimenzí a načítání dat streamováním ze vzdálené databáze).

Syntaxe

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

Pokud máte síťové připojení mezi externím zdrojem dat aplikací Essbase, připojení na úrovni aplikace nebo globální připojení a datové zdroje nejefektivněji definujete ve webovém rozhraní Essbase. Tyto definice vám pomohou snadno „stáhnout“ data z externího zdroje. Pokud mezi aplikací Essbase a externím zdrojem dat síťové připojení nemáte, načítání dat nebo sestavy dimenzí lze streamovat pomocí nástroje CLI. Nejdříve použijte tento příkaz a vytvořte místní připojení a poté vydejte příkaz dataload nebo dimbuild s volbou streamu.

Poznámky

Po migraci na verzi 21.4 nebo vyšší musí správce služby znovu vytvořit všechna uložená lokální připojení, která byla pomocí tohoto příkazu vytvořena v předchozí verzi.

Příklady

Tento příkaz požaduje jednu z následujících sad voleb:

• Datový soubor a volitelný soubor pravidel

• Soubor pravidel s uživatelským jménem a heslem

• Volba streamování odkazující na uložené místní připojení

Zdrojová databáze by měla být přístupná prostřednictvím klientské sítě, protože ne všechny ovladače databáze fungují se zástupci Java.

Při načtení dat musíte nejdřív nahrát data k načtení a soubor pravidel do adresáře krychle. K odesílání souborů můžete použít nástroj CLI. Prostudujte si téma Nahrání: přidávání souborů krychle.

Syntaxe

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]

Příklady

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"

Data také můžete načíst pomocí nástroje Cube Designer, stránky Úlohy ve webovém rozhraní aplikace Essbase nebo rozhraní REST API, případně můžete data importovat v MaxL.

Syntaxe

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

Příklady

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

esscs deletefile -CF /shared/Data.txt

Soubory lze také spravovat v nástroji Cube Designer, ve webovém rozhraní Essbase nebo v rozhraní REST API.

Syntaxe

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

Příklady

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

Krychle můžete také nasadit v nástroji Cube Designer nebo pomocí volby Import v části Aplikace webového rozhraní aplikace Essbase.

Než budete moci načíst dimenze, musíte nejprve nahrát soubory pro sestavení dimenzí a pravidla do Essbase. K odesílání souborů můžete použít nástroj CLI. Prostudujte si téma Nahrání: přidávání souborů krychle.

Syntaxe

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]

Příklady

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

Dimenze také můžete načíst pomocí nástroje Cube Designer, stránky Úlohy ve webovém rozhraní aplikace Essbase nebo rozhraní REST API, případně můžete dimenze importovat v MaxL.

Může být nutné stáhnout textové soubory, soubory pravidel nebo soubory výpočetních skriptů z krychle, aby s nimi bylo možné pracovat nebo je nahrávat do jiné krychle. Abyste mohli stáhnout artefakty krychle, potřebujete alespoň oprávnění k aktualizaci databáze.

Syntaxe

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

Příklady

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

Soubory lze také spravovat v nástroji Cube Designer, ve webovém rozhraní Essbase nebo v rozhraní REST API.

Syntaxe

[command] -help | -h

Příklady

esscs -help

esscs -h

esscs dataload -help

Syntaxe

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

Poznámky

Tento příkaz, stejně jako další příkazy CLI, lze používat mimo počítač Essbase, zatímco nástroj LCM je nutné spustit přímo na počítači Essbase.

Příklad

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

Příklad skriptu Windows

Následující skript Windows lcmexportall.bat exportuje všechny aplikace do aktuálního místního adresáře, ze kterého bylo volán příkaz 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

Syntaxe

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

Poznámky

• Tento příkaz, stejně jako další příkazy CLI, lze používat mimo počítač Essbase, zatímco nástroj LCM je nutné spustit přímo na počítači Essbase.

• Po dokončení importu LCM může být nutné provést další akci k obnovení migrovaných připojení k externím zdrojům. Chcete-li to provést, otevřete připojení a zadejte heslo.

• Když oddíly existují mezi migrovanými krychlemi, musíte zdroj dat importovat před cílem dat. V opačném případě se definice oddílů nemusí obnovit.

  Operace importu utility Lifecycle Management (LCM) (a import nástroje pro migraci) nejsou podporovány u migrace federovaných oddílů. Federované oddíly je třeba v cíli znovu vytvořit ručně.

• LCM Import neprovádí migraci ověřovacích údajů aliasů umístění. Ověřovací údaje aliasu umístění je nutné nahradit, a to buď vytvořením nových aliasů umístění pomocí MaxL, nebo úpravou ověřovacích údajů aliasu umístění ve formátu XML exportovaném nástrojem LCM Export.

Příklad

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

Syntaxe

listapp [-verbose] [-details]

Příklad

esscs listapp -v -dtl

Syntaxe

listdb [-verbose] -application applicationName [details]

Příklad

esscs listdb -v -a Sample -dtl

Artefakty krychle mohou zahrnovat datové soubory, sešity, soubory pravidel, soubory skriptů pro výpočet nebo jiné artefakty. Artefakty krychle jsou libovolné soubory, které jsou nutné k provádění akcí s aplikacemi a krychlemi.

Chcete-li zobrazit soubory pro krychli, potřebujete pro aplikaci alespoň oprávnění k přístupu k databázi. K zobrazení seznamu souborů v uživatelském adresáři nejsou nutná žádná zvláštní oprávnění.

Syntaxe

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

Příklady

esscs listfiles -t rul -a Sample -d Basic 

esscs listfiles -CP "/shared"

Soubory lze také spravovat v nástroji Cube Designer, ve webovém rozhraní Essbase nebo v rozhraní REST API.

Syntaxe

listfilters [-verbose] -application appname -db cubename 

Příklad

esscs listfilters -v -a Sample -d Basic 

Syntaxe

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

Příklad

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

Syntaxe

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

Příklady

Úroveň krychle

esscs listvariables -a Sample -db Basic

Úroveň aplikace

esscs listvariables -a Sample

Globální úroveň

esscs listvariables

Syntaxe

 setpassword [-verbose] -essbaseurl URL -user userName

Poznámky

Po migraci na vydání 21.4 nebo vyšší musíte resetovat všechna uložená hesla, která byla uložena pomocí tohoto příkazu v předchozí verzi.

Příklad

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

Syntaxe

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

Příklad

esscs start -v -a Sample -d Basic

Syntaxe

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

Příklad

esscs stop -v -a Sample -d Basic 

Syntaxe

unsetpassword [-verbose] -essbaseurl URL -user userName

Příklad

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

Před prováděním úkonů, jako je načítání dat, sestavování dimenzí, výpočty nebo jiné operace, může být nutné nahrát datové soubory, soubory pravidel, soubory výpočetních skriptů nebo jiné artefakty do adresáře krychle. Artefakty můžete též nahrát do svého uživatelského adresáře.

Pro nahrání souborů do krychle potřebujete alespoň oprávnění Správce databáze. K nahrávání do uživatelského adresáře žádná zvláštní oprávnění nepotřebujete.

Syntaxe

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

-ca gzip

-ca lz4

Příklady

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

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

Soubory lze také spravovat v nástroji Cube Designer, ve webovém rozhraní Essbase nebo v rozhraní REST API.

Syntaxe

version

Příklad

esscs version