Popis príkazov rozhrania príkazového riadka

Príkazy rozhrania príkazového riadka Essbase, ktoré zadáte v rozhraní esscs shell, vám pomôžu vykonať bežné operácie na platforme vrátane výpočtu, zavedenia dát, príkazu dimbuild, exportu LcmExport, importu LcmImport, nahratia a stiahnutia artefaktov, spustenia a zastavenia aplikácie alebo kocky a mnohých ďalších operácií.

Nasledujúce príkazy sú dostupné v rozhraní príkazového riadka. Argumenty k príkazom je možné spustiť v ľubovoľnom poradí.

Ak chcete zobraziť pomoc pre všetky príkazy, zadajte esscs -h. Ak chcete zobraziť pomoc pre konkrétny príkaz, zadajte esscs príkaz -h.

Ak chcete zapnúť výstup v režime oznamov pre príkaz, t. j. zobrazovanie rozšírených informácií (ak sú k dispozícii), zadajte esscs príkaz -v argumenty príkazu.

Login/Logout: Autentifikácia CLI

Príkaz rozhrania CLI login pre Essbase vykoná vašu autentifikáciu v Essbase, aby ste mohli používať rozhranie CLI.

Skôr než budete môcť v Essbase zadávať ďalšie príkazy rozhrania CLI, je potrebné sa prihlásiť. Ak sa vyžaduje zabezpečené pripojenie, adresa URL sa musí začínať výrazom https.

Autentifikáciu s použitím CLI môžete vykonať týmito spôsobmi:

  • Jedenkrát použite príkaz setpassword, aby sa uložilo heslo pre kombináciu klient/používateľ. V nasledujúcich reláciách môžete použiť príkaz login bez toho, aby ste boli vyzvaný na zadanie hesla.
  • Použite voľby -user a -password s príkazom login (upozornenie: heslo sa zobrazí v okne rozhrania shell nešifrované).
  • Použite iba voľbu -user s príkazom login. Zobrazí sa výzva na zadanie hesla, ktoré je skryté.

Ak ste federovaný používateľ SSO v službe Oracle Identity Cloud Service, prihlasovanie pomocou príkazov MaxL alebo CLI nie je podporované. Federované prihlásenie SSO vyžaduje okno prehľadávača. Ak sa chcete prihlásiť pomocou rozhrania MaxL alebo CLI, vytvorte na to natívneho používateľa služby Identity Cloud Service.

Syntax (login)

login [-verbose] -essbaseurl https://instance-name.example.com/essbase -user username [-password password] 
Voľba Skratka Popis
-verbose -v Zobrazí rozšírené popisy.
-essbaseurl -url Adresa inštancie Essbase.
-user -u Meno používateľa.
-password -p Voliteľné. Heslo používateľa. Alternatívne môžete nastaviť heslo pomocou príkazu setpassword.

Ak vydávate príkaz na prihlásenie zo skriptu a heslo obsahuje špeciálne znaky, ohraničte ich dvojitými úvodzovkami (napríklad "aNb3^5%9$!").

Použitie znaku $ (znak dolára) v hesle pre Essbase nie je podporované pri prihláseniach do prostredia Linux.

Príklad 1 (login)

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

Príklad 2 (login)

Prihlasujúci sa používateľ v nasledujúcom príklade admin1@example.com je administrátor služby Identity Cloud Service, ktorý bol nastavený ako prvý administrátor služby Essbase počas nasadzovania zásobníka Essbase do infraštruktúry Oracle Cloud Infrastructure. Keďže v príklade nie je zadané heslo, administrátorovi sa zobrazí výzva na jeho zadanie v ďalšom kroku. Adresou URL je essbase_url z výstupov úloh po nasadení zásobníka.

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

Syntax (logout)

logout

Príklad (logout)

esscs logout

Calc: Spustenie skriptu výpočtu

Príkaz rozhrania CLI calc pre Essbase spustí skript výpočtu pre kocku. Na spustenie tohto príkazu je potrebné mať aspoň povolenie na aktualizáciu databázy a tiež udelený prístup ku skriptu výpočtu.

Pred spustením skriptov výpočtu je potrebné najprv ich nahrať do adresára kocky ako súbory .csc. Na nahranie súborov môžete použiť príkazový riadok. Pozrite si časť Upload: Pridanie súborov kocky.

Syntax

calc [-verbose] -application appname -db cubename -script scriptfilename
Voľba Skratka Popis
-verbose -v Zobrazí rozšírené popisy.
-application -a Názov aplikácie.
-db -d Názov databázy (kocky).
-script -s Názov skriptu výpočtu. Musí mať príponu súboru .csc. Nie je potrebné zadávať úplnú cestu. Predpokladá sa, že súbory sa nachádzajú v príslušnom adresári kocky.

Príklad

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

Skripty výpočtov môžete spustiť aj pomocou voľby výpočtu v návrhárovi kocky alebo aplikácii Smart View, stránky Úlohy vo webovom rozhraní Essbase alebo rozhraní REST API, prípadne pomocou príkazu MaxL execute calculation.

Clear: Odstránenie dát z kocky

Príkaz rozhrania CLI clear pre Essbase vymaže dáta z kocky. Na použitie tohto príkazu potrebujete mať minimálne povolenie Aktualizácia databázy.

Syntax

clear [-verbose] -application appname -db cubename [-option clearOption[-regionspec regionSpec]]
Voľba Skratka Popis
-verbose -v Voliteľné. Zobrazí rozšírené popisy.
-application -a Názov aplikácie.
-db -d Názov databázy (kocky).
-option -O Voliteľné. Kľúčové slovo označujúce, čo treba vymazať. Ak hodnota nie je zadaná, predvolená voľba je ALL_DATA.

Voľby pre kocky ukladacieho priestoru blokov sú:

  • ALL_DATA – vymažú sa všetky dáta, prepojené objekty a štruktúra.

  • UPPER_LEVEL – vymažú sa kocky vyššej úrovne.

  • NON_INPUT – vymažú sa iné než vstupné bloky.

Voľby pre kocky ukladacieho priestoru agregácie sú:

  • ALL_DATA – vymažú sa všetky dáta, prepojené objekty a štruktúra.

  • ALL_AGGREGATIONS

    – vymažú sa všetky agregované dáta.
  • PARTIAL_DATA

    – vymaže sa iba zadaná dátová oblasť. Používa sa s parametrom -regionspec.
-regionspec -rs Výraz MDX označujúci oblasť na vymazanie.

Príklad

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

Dáta môžete vymazať aj pomocou voľby Zaviesť dáta v návrhárovi kociek, pomocou úloh vo webovom rozhraní Essbase alebo v rozhraní REST API, alebo pomocou príkazu alter database DBS-NAME reset v MaxL.

Createlocalconnection: Uloženie pripojenia JDBC

Príkaz rozhrania CLI createlocalconnection pre Essbase vytvorí pripojenie JDBC a uloží ho lokálne. Na používanie tohto príkazu potrebujete rolu administrátora služby alebo pokročilého používateľa.

Popis

Tento príkaz musí administrátor služby použiť na vytvorenie a uloženie lokálneho pripojenia predtým, ako budú môcť ostatní používatelia použiť príkazy CLI dataload alebo dimbuild s voľbou streamovania. Takisto je potrebné nastaviť premennú prostredia EXTERNAL_CLASSPATH, ktorá bude odkazovať na súbor .jar pre ovládač databázy (pozrite si časť Vytváranie dimenzií a zavádzanie dát streamovaním zo vzdialenej databázy).

Syntax

createLocalConnection [-verbose] -name streamConnection -connectionstring  connectionString -user userName [-driver jdbcDriver] [-password password]
Voľba Skratka Popis
-verbose -v Zobrazí rozšírené popisy.
-name -N Názov pripojenia.
-connectionstring -cs Pripojovací reťazec JDBC. Formát je možné uviesť s názvom služby nasledovne:
jdbc:oracle:thin:@host:port/service_name

alebo spolu so SID nasledovne:

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

Formáty syntaxe vyššie sa vzťahujú na databázu Oracle. Pozrite si časť Príklady, kde nájdete menšie rozdiely v syntaxi pripojovacieho reťazca, keď pracujete s inými poskytovateľmi.

-user -u Meno používateľa.
-driver -D Ovládač JDBC. Ak nie je uvedený, databáza Oracle sa považuje za predvolenú ako oracle.jdbc.driver.OracleDriver.
-password -p Heslo (voliteľné).

Ak máte sieťové pripojenie medzi externým zdrojom dát a službou Essbase, najefektívnejšie je definovať pripojenia na úrovni aplikácie alebo globálne pripojenia a dátové zdroje vo webovom rozhraní Essbase. Tieto definície vám pomôžu jednoducho načítať dáta z externého zdroja. Ak nemáte sieťové pripojenie medzi službou Essbase a externým zdrojom dát, zavádzané dáta alebo vytvárané dimenzie môžete streamovať pomocou rozhrania CLI. Najskôr je potrebné pomocou tohto príkazu vytvoriť lokálne pripojenie a potom vydať príkaz dataload alebo dimbuild s voľbou streamovania.

Poznámky

Po migrácii na vydanie 21.4 alebo novšie musí administrátor služby znova vytvoriť všetky uložené lokálne pripojenia, ktoré boli vytvorené pomocou tohto príkazu v predchádzajúcom vydaní.

Príklady

Ak nie je zadaná voľba -driver a parameter jdbcDriver, za predvolenú sa považuje databáza Oracle.

esscs createLocalConnection -N OracleDBConnection2 -cs jdbc:oracle:thin:@host1.example.com:1521/ORCL.esscs.host1.oraclecloud.com -u OracleUser

Ak nie je zadaná voľba -driver a parameter jdbcDriver, za predvolenú sa považuje databáza Oracle.

esscs createLocalConnection -N OracleDBConnection1 -cs jdbc:oracle:thin:@myhostname01:1521:ORCL -u OracleUser -D oracle.jdbc.driver.OracleDriver

Ak nie je zadaná voľba -driver a parameter jdbcDriver, za predvolenú sa považuje databáza Oracle.

esscs createLocalConnection -N DB2conn -cs jdbc:db2://myhostname02.example.com:50000/TBC -u myDB2User -D com.ibm.db2.jcc.DB2Driver

Ak nie je zadaná voľba -driver a parameter jdbcDriver, za predvolenú sa považuje databáza Oracle.

esscs createLocalConnection -N MySQLconn -cs jdbc:mysql://myhostname03.example.com:3306/tbc -u MySQLUsr -D com.mysql.jdbc.Driver

Ak nie je zadaná voľba -driver a parameter jdbcDriver, za predvolenú sa považuje databáza Oracle.

esscs createLocalConnection -N MSSQLConn -cs jdbc:sqlserver://myhostname04.example.com:1433 -u MSSQLUsr -D com.microsoft.sqlserver.jdbc.SQLServerDriver

Ak nie je zadaná voľba -driver a parameter jdbcDriver, za predvolenú sa považuje databáza Oracle.

esscs createLocalConnection -N TeraDconn -cs jdbc:teradata://myhostname05.example.com/DBS_PORT=1025 -u TeraUsr -D com.teradata.jdbc.TeraDriver

Dataload: Zavedenie dát do kocky

Príkaz rozhrania CLI dataload pre Essbase zavedie dáta do kocky. Na použitie tohto príkazu potrebujete mať minimálne povolenie Aktualizácia databázy.

Tento príkaz vyžaduje jednu z nasledujúcich množín volieb:

  • Dátový súbor a voliteľný súbor pravidiel

  • Súbor pravidiel s menom používateľa a heslom

  • Voľba streamovania odkazujúca na uložené lokálne pripojenie

Zdrojová databáza musí byť prístupná v rámci klientskej siete, pretože nie všetky databázové ovládače dokážu pracovať so servermi proxy Java.

Ak chcete zaviesť dáta, je potrebné najprv nahrať zavedenie dát a súbory pravidiel do adresára kocky. Na nahranie súborov môžete použiť príkazový riadok. Pozrite si časť Upload: Pridanie súborov kocky.

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]
Voľba Skratka Popis
-verbose -v Zobrazí rozšírené popisy.
-application -a Názov aplikácie.
-db -d Názov databázy (kocky).
-file -f Názov súboru zavedenia dát. Nie je potrebné zadávať úplnú cestu. Predpokladá sa, že súbory sa nachádzajú v príslušnom adresári databázy. Namiesto tejto voľby môžete použiť prepínač -catalogfile.
-rule -r Voliteľné. Názov súboru pravidiel. Nie je potrebné zadávať úplnú cestu. Predpokladá sa, že súbory sa nachádzajú v príslušnom adresári databázy. Namiesto tejto voľby môžete použiť prepínač -catalogrulefile.
-catalogfile -CF Názov súboru zavedenia dát z katalógu súborov. Túto voľbu môžete použiť namiesto voľby -file.
-catalogrulefile -CRF Názov súboru pravidiel z katalógu súborov. Túto voľbu môžete použiť namiesto prepínača -rule.
-user -u Voliteľné. Meno používateľa. V prípade použitia vyžaduje heslo.

Ak používate uložené pripojenie a dátový zdroj, žiadne meno používateľa ani heslo sa nevyžaduje. Ak nepoužívate uložené pripojenie a súbor pravidiel sa pripája k RDBMS, zadajte meno používateľa a heslo na pripojenie k RDBMS.

-password -p Voliteľné. Heslo používateľa. V prípade vynechania sa používateľovi zobrazí výzva na zadanie hesla.
-stream -S Voliteľné. Použite streamovanie zavedenia dát. V prípade použitia vyžaduje voľbu -conn.
-connection -conn Vyžaduje sa, ak sa použila voľba streamovania. Názov uloženého pripojenia, ktoré bolo vytvorené pomocou príkazu CLI createlocalconnection.
-query -q Voliteľné. Dopyt na databázu na odoslanie spolu s nahratím dát streamovania.
-rows -rows Voliteľné. Počet riadkov, ktoré sa majú simultánne streamovať. Predvolená hodnota je 100.
-abortOnError -abort V prípade chyby preruší zavedenie dát.

Prí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"

Dáta môžete zaviesť aj pomocou návrhára kociek, sekcie Úlohy vo webovom rozhraní Essbase alebo v rozhraní REST API, prípadne pomocou importu dát v MaxL.

Deletefile: Odstránenie súborov kocky

Príkaz rozhrania CLI deletefile pre Essbase odoberie artefakty kocky z aplikácie, databázy alebo domovského adresára používateľa. Ak chcete odstrániť súbory z kocky, potrebujete povolenie minimálne na úrovni správcu databázy pre kocku. Na odstránenie súborov z vlastného adresára používateľa sa nevyžadujú žiadne špeciálne povolenia.

Syntax

deletefile [-verbose] -file fileName [-application application [-db  database] [| -catalogfile catalogFile]]
Voľba Skratka Popis
-verbose -v Zobrazí rozšírené popisy.
-file -f Názov súboru na odstránenie.
-application -a Voliteľné. Názov aplikácie. Ak nie je uvedený, predpokladá sa, že súbory sa nachádzajú v domovskom adresári používateľa.
-database -db Voliteľné. Názov databázy (kocky).
-catalogfile -CF Cesta a názov súboru z katalógu súborov. Túto voľbu môžete použiť namiesto voľby -file.

Príklady

esscs deletefile -a Sample -d Basic -f Act1.rul
esscs deletefile -CF /shared/Data.txt

Súbory môžete spravovať aj v návrhárovi kociek, vo webovom rozhraní Essbase alebo v rozhraní REST API.

Deploy: Vytvorenie kocky zo zošita

Príkaz rozhrania CLI deploy pre Essbase vytvorí kocku zo zošita aplikácie Excel. Na spustenie tohto príkazu je potrebné mať minimálne rolu Pokročilý používateľ.

Syntax

deploy [-verbose] -file fileName [-application application [-database database] | -catalogfile catalogFile] [-restructureoption restructureOption] [-loaddata] [-recreateapplication] [-createfiles] [-executescript]
Voľba Skratka Popis
-verbose -v Zobrazí rozšírené popisy.
-file -f Názov súboru zošita aplikácie.
-application -a Voliteľné. Názov aplikácie. Ak nie je poskytnutý, názov aplikácie sa zoberie zo zošita.
-database -db Voliteľné. Názov databázy (kocky). Ak nie je poskytnutý, názov databázy sa zoberie zo zošita.
-catalogfile -CF Zošit aplikácie z katalógu súborov. Túto voľbu môžete použiť namiesto voľby -file.
-loaddata -l Voliteľné. Zaveďte dáta, ak zošit aplikácie obsahuje dátový pracovný hárok. V opačnom prípade sa do kocky importujú iba metadáta.
-restructureoption -R Voliteľné. Kľúčové slovo označujúce požadovanú voľbu zmeny štruktúry.

Voľby pre kocky ukladacieho priestoru blokov sú:

  • ALL_DATA – zachovať všetky dáta.

  • NO_DATA – nezachovať žiadne dáta.

  • LEAFLEVEL_DATA – zachovať dáta na úrovni 0 (úroveň listu).

  • INPUT_DATA – zachovať vstupné dáta.

Voľby pre kocky ukladacieho priestoru agregácie sú:

  • ALL_DATA – zachovať všetky dáta.

  • NO_DATA – nezachovať žiadne dáta.

-recreateapplication -ra Voliteľné. Znova vytvorí aplikáciu, ak už existuje.
-createfiles -cf Voliteľné. Vytvorte artefakty kocky v adresári súborov v službe Essbase.
-executescript -e Voliteľné. Vykoná skripty výpočtov. Používa sa len v prípade, že zošit aplikácie obsahuje pracovný hárok výpočtov s voľbou Spustiť skript nastavenou v definíciách na hodnotu Áno.

Prí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

Môžete tiež nasadiť kocky pomocou návrhára kociek alebo pomocou voľby Importovať v sekcii Aplikácie vo webovom rozhraní Essbase.

Dimbuild: Zavedenie dimenzií do kocky

Príkaz rozhrania CLI dimbuild pre Essbase zavedie dimenzie do kocky. Ak chcete spustiť tento príkaz, potrebujete povolenie minimálne na úrovni správcu databázy pre kocku.

Skôr ako budete môcť zaviesť dimenzie, do Essbase je potrebné nahrať súbory vytvorenia dimenzií a súbory pravidiel. Na nahranie súborov môžete použiť príkazový riadok. Pozrite si časť Upload: Pridanie súborov kocky.

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]
Voľba Skratka Popis
-verbose -v Zobrazí rozšírené popisy.
-application -a Názov aplikácie.
-db -d Názov databázy (kocky).
-file -f Názov súboru vytvorenia dimenzie. Nie je potrebné zadávať úplnú cestu. Predpokladá sa, že súbory sa nachádzajú v príslušnom adresári aplikácie alebo databázy Namiesto tejto voľby môžete použiť prepínač -catalogfile.
-rule -r Názov súboru pravidiel. Nie je potrebné zadávať úplnú cestu. Predpokladá sa, že súbory sa nachádzajú v príslušnom adresári aplikácie alebo databázy Namiesto tejto voľby môžete použiť prepínač -catalogrulefile.
-catalogfile -CF Názov súboru vytvorenia dimenzie z katalógu súborov. Túto voľbu môžete použiť namiesto voľby -file.
-catalogrulefile -CRF Názov súboru pravidiel z katalógu súborov. Túto voľbu môžete použiť namiesto prepínača -rule.
-user -u Voliteľné. Meno používateľa. V prípade použitia vyžaduje heslo.

Ak používate uložené pripojenie a dátový zdroj, žiadne meno používateľa ani heslo sa nevyžaduje. Ak nepoužívate uložené pripojenie a súbor pravidiel sa pripája k RDBMS, zadajte meno používateľa a heslo na pripojenie k RDBMS.

-password -p Voliteľné. Heslo používateľa. V prípade vynechania sa používateľovi zobrazí výzva na zadanie hesla.
-stream -S Voliteľné. Použite streamovanie vytvorenia dimenzie. V prípade použitia vyžaduje voľbu -conn.
-connection -conn Vyžaduje sa, ak sa použila voľba streamovania. Názov uloženého pripojenia, ktoré bolo vytvorené pomocou príkazu CLI createlocalconnection.
-query -q Voliteľné. Dopyt na databázu na odoslanie spolu s vytvorením dimenzie streamovania.
-rows -rows Voliteľné. Počet riadkov, ktoré sa majú simultánne streamovať. Predvolená hodnota je 100.
-restructureOption -R

Ovláda voľby zachovania pre zmenu štruktúry.

Možné voľby pre ukladací priestor blokov sú:

  • ALL_DATA: pri zavádzaní dimenzií zachová všetky dáta.
  • NO_DATA: nezachová dáta.
  • LEAFLEVEL_DATA: zachová len dátové hodnoty na úrovni 0. Túto voľbu by ste mali vybrať v prípade, že sa všetky dáta potrebné na výpočet nachádzajú v členoch na úrovni 0. Pred zmenou štruktúry kocky sa odstránia všetky bloky vyššej úrovne. Keď sa kocka prepočíta, bloky vyššej úrovne sa vytvoria znova.
  • INPUT_DATA: zachová len vstupné dáta.

Možné voľby pre ukladací priestor agregácie sú:

  • ALL_DATA: pri zavádzaní dimenzií zachová všetky dáta.
  • NO_DATA: nezachová dáta.
-forcedimbuild -F Pokračujte vo vytváraní dimenzie, aj keď prebiehajú činnosti iných používateľov. Tým sa zrušia aktívne používateľské relácie.

Prí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

Dimenzie môžete zaviesť aj pomocou návrhára kociek, stránky Úlohy vo webovom rozhraní Essbase alebo v rozhraní REST API, prípadne pomocou importu dimenzií v MaxL.

Stiahnutie: Získanie súborov kocky

Príkaz CLI download pre Essbase stiahne artefakty kocky z inštancie Essbase do lokálneho adresára.

Môže byť potrebné stiahnuť textové súbory, súbory pravidiel alebo súbory skriptov výpočtov z kocky, aby ste s nimi mohli pracovať alebo ich nahrať do inej kocky. Na stiahnutie artefaktov kocky potrebujete povolenie minimálne na úrovni aktualizácie databázy.

Syntax

download [-verbose] -file filename[ | -catalogfile catalogFile] [-application appname [-db cubename]] [-localdirectory path] [-overwrite] [-nocompression]
Voľba Skratka Popis
-verbose -v Zobrazí rozšírené popisy.
-file -f Názov súboru, ktorý chcete stiahnuť.
-application -a Voliteľné. Názov aplikácie. Ak hodnota nie je uvedená, stiahnu sa artefakty z domovského adresára používateľa.
-db -d Voliteľné. Názov databázy (kocky).
-catalogfile -CF Súbor v katalógu súborov. Túto voľbu môžete použiť namiesto voľby -file.
-localdirectory -ld Voliteľné. Cesta k lokálnemu adresáru.
-overwrite -o Voliteľné. Prepísať existujúci súbor.
-nocompression -nc Voliteľné. Deaktivovať kompresiu prenosu dát.

Prí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

Súbory môžete spravovať aj v návrhárovi kociek, vo webovom rozhraní Essbase alebo v rozhraní REST API.

Pomoc: Zobrazenie syntaxe príkazov

Príkaz CLI help pre Essbase zobrazuje pomoc na úrovni príkazu v konzole alebo v termináli.

Syntax

[command] -help | -h

Príklady

esscs -help
esscs -h
esscs dataload -help

LcmExport: Zálohovanie súborov kocky

Príkaz CLI lcmexport pre Essbase zálohuje aplikácie a artefakty kocky do súboru .zip utility Lifecycle Management (LCM), ktorý stiahne do lokálneho počítača. Ak chcete spustiť tento príkaz, potrebujete povolenie minimálne na úrovni správcu aplikácie.

Syntax

lcmExport [-verbose] -application appname|-allApp -zipfilename filename [-localDirectory path][-threads threadscount][-skipdata][-overwrite][-generateartifactlist][-include-server-level][-cube][-exportdata][-filetype][-exportpartitions][-exportfilters][-restEncryPassword]
Voľba Skratka Popis
-verbose -v Voliteľné. Zobrazí rozšírené popisy.
-application -a Názov aplikácie, ktorú chcete zálohovať.
-allApp -aa Voliteľné (a s rozlišovaním malých a veľkých písmen). Ak sa použije namiesto voľby -application, exportuje všetky aplikácie do jedného súboru zip. Príkaz lcmimport akceptuje súbory zip s jednou aplikáciou alebo súbory zip s viacerými aplikáciami.
-zipfilename -z Voliteľné. Názov komprimovaného súboru, do ktorého sa majú uložiť záložné súbory.
-localdirectory -ld Voliteľné. Cesta k lokálnemu adresáru. Ak nie je zadaná, súbor zip je uložený v adresári <Application Directory>/catalog/users/<user_name> na serveri Essbase.
-threads -T Voliteľné. Počet vlákien, ktoré sa majú použiť pri paralelnom exportovaní. Minimum: 10
-skipdata -skip Voliteľné. Nezahŕňať dáta do zálohy.
-overwrite -o Voliteľné. Prepísať existujúci záložný súbor.
-generateartifactlist -gal Voliteľné. Vygeneruje textový súbor obsahujúci kompletný zoznam exportovaných artefaktov. Tento textový súbor môžete používať na spravovanie importu artefaktov. Môžete napríklad usporiadať poradie artefaktov v zozname, v akom sa artefakty budú importovať. Importovanie niektorých artefaktov môžete vynechať tak, že odstránite alebo okomentujete príslušné položky v zozname.
-include-server-level -isl Voliteľné. Zahrňte globálne definované pripojenia a dátové zdroje.
-cube -c Voliteľné. Exportuje sa jedna kocka. Túto voľbu možno zadať len s voľbami exportu dát, súborov určitých typov, partícií alebo filtrov.
-exportdata -d Voliteľné. Len export dát.
-filetype -ft

Voliteľné. Exportujú sa len súbory zadaného typu. Medzi podporované typy súborov patrí OTL (štruktúra), TXT (text), RUL (pravidlo), CSC (skript výpočtu), DTR (definícia zostavy zobrazenia súvisiacich údajov) a Excel (exportujú sa len súbory .xls a žiadne súbory .xlsx sa neexportujú).

Príklady:

esscs lcmexport -a sample -z sampleXLSOnly.zip -v -ft excel
esscs lcmexport -a sample -z sampleTXTOnly.zip -v -ft txt
-exportpartitions -ep

Voliteľné. Exportujú sa len definície partície.

Operácie importu utility Lifecycle Management (LCM) (a import utility migrácie) nie sú pre migráciu federovaných partícií podporované. Federované partície je potrebné manuálne znovu vytvoriť v cieli.

-exportfilters -ef Voliteľné. Exportujú sa len filtre zabezpečenia.
-restEncryPassword -encryPwd

Ak je aplikácia šifrovaná, heslo na ochranu šifrovanej aplikácie počas migrácie. Heslo musí mať od 6 do 15 znakov a nesmie obsahovať žiadne z nasledujúcich špeciálnych znakov: ?=.,*!@#&()[{}]:;'/~$^+<>-

Upozornenie: Ak toto heslo zabudnete, nie je možné ho získať a aplikáciu nie je možné importovať.

Poznámky

Podobne ako iné príkazy rozhrania príkazového riadka, aj tento príkaz možno spúšťať z iného počítača ako je počítač Essbase. Utilita LCM však musí byť spustená v počítači Essbase.

Príklad

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

Príklad skriptu systému Windows

Nasledujúci skript systému Windows, lcmexportall.bat, exportuje všetky aplikácie do aktuálneho lokálneho adresára, z ktorého bol vyvolaný prí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

LcmImport: Obnovenie súborov kocky

Príkaz CLI lcmimport pre Essbase obnoví artefakty kocky zo súboru .zip utility Lifecycle Management (LCM). Ak chcete spustiť tento príkaz, je potrebné, aby ste boli pokročilý používateľ, ktorý vytvoril danú aplikáciu, alebo administrátor služby.

Syntax

lcmImport [-verbose] -zipfilename filename [-overwrite] [-targetappName targetApplicationName][-include-server-level][-artifactlist artifactList][-restEncryPassword]
Voľba Skratka Popis
-verbose -v Voliteľné. Zobrazí rozšírené popisy.
-zipfilename -z Názov komprimovaného súboru obsahujúceho záložné súbory.
-overwrite -o Voliteľné. Znova vytvorí cieľovú aplikáciu.
-targetappName -ta Voliteľné. Názov cieľovej aplikácie, ak chcete, aby sa líšil od názvu zdroja.
-artifactlist -al Voliteľné. Názov súboru obsahujúceho zoznam artefaktov na import. Tento súbor môže byť generovaný v procese lcmexport.

Ak chcete vynechať artefakty, okomentujte alebo odstráňte položky zo zoznamu. Ak chcete napríklad vynechať importovanie záznamov auditu, riadok okomentujte takto:

# ------------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

Ak chcete určiť poradie importu, v textovom súbore zmeňte usporiadanie položiek import.

Ak sa použije argument –overwrite, pri operácii importu sa odstráni a znova vytvorí celá aplikácia, pričom sa naimportujú len artefakty prítomné v zozname. Ak sa argument –overwrite nepoužije, do operácie importu sa zahrnú artefakty zadané v zozname, čo však neovplyvní iné artefakty, ktoré už sú prítomné v cieľovej aplikácii.

-include-server-level -isl Voliteľné. Zahrňte globálne definované pripojenia a dátové zdroje.
-restEncryPassword -encryPwd

Ak je aplikácia šifrovaná, heslo na ochranu šifrovanej aplikácie počas migrácie. Heslo musí mať od 6 do 15 znakov a nesmie obsahovať žiadne z nasledujúcich špeciálnych znakov: ?=.,*!@#&()[{}]:;'/~$^+<>-

Upozornenie: Ak toto heslo zabudnete, nie je možné ho získať a aplikáciu nie je možné importovať.

Poznámky

  • Podobne ako iné príkazy rozhrania príkazového riadka, aj tento príkaz možno spúšťať z iného počítača ako je počítač Essbase. Utilita LCM však musí byť spustená v počítači Essbase.

  • Po dokončení importu LCM môže byť potrebné vykonať ďalšiu akciu na obnovenie migrovaných pripojení k externým zdrojom. Ak to chcete vykonať, otvorte pripojenie a zadajte heslo.

  • Ak existujú partície medzi migrovanými kockami, dátový zdroj je potrebné importovať pred dátovým cieľom. V opačnom prípade sa definície partícií nemusia obnoviť.

    Operácie importu utility Lifecycle Management (LCM) (a import utility migrácie) nie sú pre migráciu federovaných partícií podporované. Federované partície je potrebné manuálne znovu vytvoriť v cieli.

  • Pri importe LCM sa nemigrujú doklady aliasu umiestnenia. Doklady aliasu umiestnenia je potrebné nahradiť, a to buď opätovným vytvorením aliasov umiestnení pomocou príkazov MaxL, alebo úpravou dokladov aliasu umiestnenia v súbore XML exportovanom prostredníctvom exportu LCM.

Príklad

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

Listapp: Zobrazenie aplikácií

Príkaz CLI listapp zobrazí zoznam aplikácií, ku ktorým máte prístup v tejto inštancii Essbase.

Syntax

listapp [-verbose] [-details]
Voľba Skratka Popis
-verbose -v Voliteľné. Zobrazí rozšírené popisy.
-details -dtl Voliteľné. Zobrazí ďalšie detaily vo výstupe (typ aplikácie a aktuálny stav).

Príklad

esscs listapp -v -dtl

Listdb: Zobrazenie kociek

Príkaz CLI listdb zobrazí databázy, ku ktorým máte prístup v rámci zadanej aplikácie Essbase.

Syntax

listdb [-verbose] -application applicationName [details]
Voľba Skratka Popis
-verbose -v Voliteľné. Zobrazí rozšírené popisy.
-application -a Názov aplikácie.
-details -dtl Voliteľné. Zobrazí detaily stavu vo výstupe.

Príklad

esscs listdb -v -a Sample -dtl

Listfiles: Zobrazenie súborov

Príkaz rozhrania CLI listfiles vytvorí zoznam artefaktov kocky, ktoré existujú v inštancii Essbase.

Artefakty kocky môžu zahŕňať dátové súbory, zošity, súbory pravidiel, súbory skriptov výpočtov alebo iné artefakty. Artefakty kocky zahŕňajú ľubovoľné súbory, ktoré sú potrebné na vykonávanie akcií v aplikáciách a kockách.

Ak chcete zobraziť zoznam súborov kocky, pre aplikáciu potrebujete povolenie minimálne na úrovni Prístup k databáze. Na zobrazenie zoznamu súborov z vlastného adresára používateľa sa nevyžadujú žiadne špeciálne povolenia.

Syntax

listfiles [-verbose] [-type filetype] [-application appname [-db cubename] | -catalogpath catalogPath] 
Voľba Skratka Popis
-verbose -v Voliteľné. Zobrazí rozšírené popisy.
-type -t Voliteľné. Prípona/typ súboru na zobrazenie bez bodky.

Podporované typy súborov sú:

  • .csc (skripty výpočtov)
  • .rul (súbory pravidiel)
  • .txt (textové súbory)
  • .msh (skripty MaxL)
  • .xls, .xlsx (zošity programu Excel)
  • .xlsm (zošity programu Excel s povolenými makrami)
  • .xml (súbory XML)
  • .zip (komprimované súbory zip)
  • .csv (súbory s hodnotami oddelenými čiarkou)
-application -a Voliteľné. Názov aplikácie. Ak hodnota nie je zadaná, zobrazia sa súbory z domovského adresára používateľa.
-db -d Voliteľné. Názov databázy (kocky).
-catalogpath -CP Voliteľné. Cesta katalógu k názvu súboru. Môže sa použiť namiesto -a [-d] na zadanie umiestnenia súborov v katalógu.

Príklady

esscs listfiles -t rul -a Sample -d Basic 
esscs listfiles -CP "/shared"

Súbory môžete spravovať aj v návrhárovi kociek, vo webovom rozhraní Essbase alebo v rozhraní REST API.

Listfilters: Zobrazenie filtrov zabezpečenia

Príkaz rozhrania CLI listfilters zobrazí zoznam filtrov zabezpečenia Essbase. Na zobrazenie filtrov pre akékoľvek kocky v aplikácii musíte mať v aplikácii povolenie minimálne na úrovni správcu databázy.

Syntax

listfilters [-verbose] -application appname -db cubename 
Voľba Skratka Popis
-verbose -v Voliteľné. Zobrazí rozšírené popisy.
-application -a Názov aplikácie.
-db -d Názov databázy (kocky).

Príklad

esscs listfilters -v -a Sample -d Basic 

Listlocks: Zobrazenie zámkov

Príkaz rozhrania CLI listlocks pre Essbase zobrazí uzamknuté dátové bloky alebo objekty súvisiace s kockou. Na spustenie tohto príkazu potrebujete v aplikácii povolenie minimálne na úrovni Prístup k databáze.

Syntax

listlocks [-verbose] -application appname -db cubename [-object] 
Voľba Skratka Popis
-verbose -v Voliteľné. Zobrazí rozšírené popisy.
-application -a Názov aplikácie.
-db -d Názov databázy (kocky).
-object -obj Voliteľné. Zobrazí uzamknuté súbory/artefakty.

Príklad

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

Listvariables: Zobrazenie substitučných premenných

Príkaz CLI listvariables pre Essbase zobrazí zoznam substitučných premenných, ktoré sú definované v rozsahu kocky, aplikácie alebo v globálnom rozsahu. Potrebujete povolenie minimálne na úrovni prístupu k databáze na zobrazenie premenných pre kocku, rolu správcu aplikácie na zobrazenie premenných pre aplikáciu a rolu administrátora služby na zobrazenie globálnych premenných.

Syntax

listvariables [-verbose] [-application application [-db database]]
Voľba Skratka Popis
-verbose -v Zobrazí rozšírené popisy.
-application -a Voliteľné. Názov aplikácie.
-database -db Voliteľné. Názov databázy (kocky).

Príklady

Úroveň kocky

esscs listvariables -a Sample -db Basic

Úroveň aplikácie

esscs listvariables -a Sample

Globálna úroveň

esscs listvariables

Setpassword: Ukladanie dokladov CLI

Príkaz rozhrania CLI setpassword pre Essbase uloží heslo priradené k vašej kombinácii klient/používateľ. V nasledujúcich reláciách sa môžete prihlásiť bez zadania hesla.

Syntax

 setpassword [-verbose] -essbaseurl URL -user userName
Voľba Skratka Popis
-verbose -v Voliteľné. Zobrazí rozšírené popisy.
-essbaseurl -url Adresa inštancie Essbase.
-user -u Vaše meno používateľa.

Poznámky

Po migrácii na vydanie 21.4 alebo vyššie je potrebné znovunastaviť všetky uložené heslá, ktoré boli pomocou tohto príkazu uložené v predchádzajúcom vydaní.

Príklad

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

Start: Spustenie aplikácie alebo kocky

Príkaz rozhrania CLI start spustí aplikáciu alebo kocku Essbase a zavedie ju do pamäte. Na spustenie tohto príkazu potrebujete v aplikácii povolenie minimálne na úrovni Prístup k databáze.

Syntax

start [-verbose] -application appname [-db cubename]
Voľba Skratka Popis
-verbose -v Voliteľné. Zobrazí rozšírené popisy.
-application -a Názov aplikácie.
-db -d Voliteľné. Názov databázy (kocky).

Príklad

esscs start -v -a Sample -d Basic

Stop: Zastavenie aplikácie alebo kocky

Príkaz CLI stop zastaví aplikáciu alebo kocku Essbase. Na spustenie tohto príkazu potrebujete v aplikácii povolenie minimálne na úrovni Prístup k databáze.

Syntax

stop [-verbose] -application appname [-db cubename]
Voľba Skratka Popis
-verbose -v Voliteľné. Zobrazí rozšírené popisy.
-application -a Názov aplikácie.
-db -d Voliteľné. Názov databázy (kocky).

Príklad

esscs stop -v -a Sample -d Basic 

Unsetpassword: Odstránenie uložených dokladov CLI

Príkaz rozhrania CLI unsetpassword pre Essbase odoberie uložené prihlasovacie doklady priradené ku kombinácii klient/používateľ a zruší účinok príkazu setpassword.

Syntax

unsetpassword [-verbose] -essbaseurl URL -user userName
Voľba Skratka Popis
-verbose -v Zobrazí rozšírené popisy.
-essbaseurl -url Adresa inštancie Essbase.
-user -u Používateľ, ktorého nastavenie hesla sa má zrušiť.

Príklad

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

Upload: Pridanie súborov kocky

Príkaz rozhrania CLI upload nahrá artefakty kocky z lokálneho adresára do inštancie Essbase.

Ak chcete vykonávať úlohy ako zavádzanie dát, vytváranie dimenzií, výpočty alebo iné operácie, do adresára kocky môže byť potrebné nahrať dátové súbory, súbory pravidiel, súbory skriptov výpočtov alebo ďalšie artefakty. Môžete tiež nahrať artefakty do svojho adresára používateľa.

Ak chcete nahrať súbory do kocky, potrebujete povolenie minimálne na úrovni správcu databázy. Na nahrávanie do vlastného adresára používateľa nie sú potrebné žiadne špeciálne povolenia.

Poznámka:

Vo webovom rozhraní Essbase môžete aktivovať vyhľadávanie vírusov, aby sa v súboroch pred nahraním na server kontroloval výskyt vírusov.

Syntax

upload [-verbose] -file filename [-application appname [-db cubename] | -catalogpath catalogPath] [-overwrite] [-nocompression][-compressionalgorithm]
Voľba Skratka Popis
-verbose -v Voliteľné. Zobrazí rozšírené popisy.
-file -f Názov súboru, ktorý sa má nahrať.

Poznámka:

Prípony súborov musia byť napísané malými písmenami. Príklad: filename.txt.
-application -a Voliteľné. Názov aplikácie. Ak nie je k dispozícii, súbory sa nahrajú do vášho adresára používateľa alebo do katalógu s cestou zadanou v -CP.
-db -d Voliteľné. Názov databázy (kocky). Vyžaduje sa -a.
-catalogpath -CP Voliteľné. Cesta katalógu k názvu súboru. Môže sa použiť namiesto -a [-d] na zadanie umiestnenia súboru v katalógu.
-overwrite -o Voliteľné. Prepísať existujúci súbor.
-nocompression -nc Voliteľné. Deaktivovať kompresiu prenosu dát.
-compressionalgorithm -ca Voliteľné. K dispozícii, ak sa nepoužíva -nc. Definuje, ktorý algoritmus kompresie sa použije na prenos dát. Možnosti: gzip alebo lz4.
  • gzip - predvolená možnosť, ak sa používa kompresia. Umožňuje menšie prenosy dát s pomalšími výpočtami.

  • lz4 - umožňuje rýchlejšie výpočty s pomalším prenosom dát.

Príklady použitia:

-ca gzip
-ca lz4

Prí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

Súbory môžete spravovať aj v návrhárovi kociek, vo webovom rozhraní Essbase alebo v rozhraní REST API.

Version: Zobrazenie verzie rozhrania API

Príkaz rozhrania CLI version načíta verziu rozhrania REST API, ktoré je priradené k tejto inštancii Essbase.

Syntax

version

Príklad

esscs version