CLI parancsok referenciája

Az esscs rendszerhéjban kiadott Essbase CLI-parancsok segítenek a platform rutinműveleteiben, beleértve a következőket: calc, dataload, dimbuild, lcmexport, lcmimport, modellelemek fel- és letöltése, alkalmazás vagy kocka elindítása és leállítása stb.

A parancssori felületen az alábbi parancsok érhetők el. A parancsokhoz tartozó argumentumokat bármilyen sorrendben meg lehet adni.

A parancsokhoz tartozó súgó megjelenítéséhez írja be: esscs -h. Ha egy konkrét parancshoz tartozó súgóra kíváncsi, írja be: esscs parancs -h.

A parancsokra vonatkozó részletes kimenet megjelenítéséhez írja be: esscs parancs -v parancs argumentumai.

Login/Logout: CLI-hitelesítés

Az Essbase login CLI parancsa hitelesíti az Essbase alkalmazást, így használhatja a CLI-t.

Mielőtt bármilyen más CLI-parancsot kiadhatna az Essbase számára, be kell jelentkeznie. Ha biztonságos kapcsolatot kíván használni, az URL-címnek a https szócskával kell kezdődnie.

Az alábbi módokon végezheti el a hitelesítést a CLI használatával:

  • Használja a setpassword műveletet egyszer, hogy a rendszer eltárolja a jelszót kliens/felhasználó kombinációhoz. A következő munkamenetekben a login parancs segítségével jelszó megadása nélkül jelentkezhet be.
  • Használja a -user és -password lehetőségeket a login paranccsal (figyelmeztetés: a jelszó titkosítatlan szövegként jelenik meg a parancssor ablakban).
  • Csak a -user lehetőséget használja a login paranccsal. A rendszer felszólítja a jelszó megadására (a jelszó rejtve van).

Ha Ön összevont SSO-felhasználó az Oracle Identity Cloud Service szolgáltatásban, a MaxL vagy CLI használatával történő bejelentkezése nem támogatott. Az összevont SSO-bejelentkezéshez böngészőablakra van szükség. Hozzon létre eredeti Identity Cloud Service-felhasználót, és azt használja a MaxL vagy CLI használatával történő bejelentkezés helyett.

Szintaxis (login)

login [-verbose] -essbaseurl https://instance-name.example.com/essbase -user username [-password password] 
Beállítás Rövidítés Leírás
-verbose -v Részletes leírás megjelenítése
-essbaseurl -url Az Essbase egy példányának címe
-user -u Felhasználónév
-password -p Nem kötelező. A felhasználó jelszava. Másik lehetőségként adja meg a jelszót a következő használatával: setpassword.

Ha egy parancsfájlban kiadja a login (bejelentkezés) parancsot, és a jelszó speciális karaktereket tartalmaz, tegye azokat idézőjelek közé (például: "aNb3^5%9$!").

A $ (dollárjel) karakter használata az Essbase-jelszóban nem támogatott, ha Linux-környezetben jelentkezik be.

Példa 1 (login)

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

Példa 2 (login)

A következő példában a bejelentkező felhasználó (admin1@example.com) egy olyan Identity Cloud Service-rendszergazda, aki kezdeti Essbase-rendszergazdaként lett beállítva az Essbase-veremnek az Oracle Cloud Infrastructure szolgáltatásba telepítése során. Mivel a példában nincs megadva a jelszó, a rendszer felszólítja a rendszergazdát, hogy a következő lépésben adja meg. Az URL-cím a feladat kimeneti adataiból származó essbase_url cím, amely a verem telepítése eredményeként jött létre.

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

Szintaxis (logout)

logout

Példa (logout)

esscs logout

Calc: Számítási parancsfájl futtatása

Az Essbase calc CLI parancsa számítási parancsfájlt hajt végre a kockán. Ezen parancs futtatásához legalább Adatbázis-módosítási engedély szükséges hozzá, valamint a felhasználónak engedélyezetten hozzá férnie a számítási parancsfájlhoz.

A számítási parancsfájlok futtatása előtt először fel kell töltenie a parancsfájlokat .csc fájlként a kockakönyvtárba. A fájlok feltöltéséhez használja a CLI felületet. Lásd: Upload: Kockafájlok felvétele.

Szintaxis

calc [-verbose] -application appname -db cubename -script scriptfilename
Beállítás Rövidítés Leírás
-verbose -v Részletes leírás megjelenítése
-application -a Alkalmazás neve
-db -d Az adatbázis (kocka) neve.
-script -s A számítási parancsfájl neve. A .csc fájlkiterjesztést használja. Nem kell megadnia a teljes elérési útvonalat. A rendszer úgy veszi, hogy a fájlok a releváns kockakönyvtárban találhatók.

Példa

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

A számítási parancsfájlok futtatását a Cube Designer Számítás opciójával, a Smart View szolgáltatással, az Essbase webes felületének a Feladatok opciójával vagy a REST API segítségével, illetve a MaxL szolgáltatás számítás végrehajtása parancsával is végrehajthatja.

Clear: Adatok eltávolítása a kockából

Az Essbase clear CLI parancsa törli az adatokat a kockából. Ezen parancs használatához legalább Adatbázis-módosítási engedéllyel kell rendelkeznie.

Szintaxis

clear [-verbose] -application appname -db cubename [-option clearOption[-regionspec regionSpec]]
Beállítás Rövidítés Leírás
-verbose -v Nem kötelező. Részletes leírás megjelenítése
-application -a Alkalmazás neve
-db -d Az adatbázis (kocka) neve.
-option -O Nem kötelező. Az eltávolítandó adatok meghatározására szolgáló kulcsszó. Alapértelmezett beállítás, ha kihagyja, akkor ALL_DATA.

A blokktárolós kockákhoz elérhető beállítások:

  • ALL_DATA – A rendszer az összes adatot, társított objektumot és a szerkezetet is törli.

  • UPPER_LEVEL – A rendszer törli a felső szintű blokkokat

  • NON_INPUT – A rendszer törli a nem bemeneti blokkokat

A összesítéstárolós kockákhoz elérhető beállítások:

  • ALL_DATA – A rendszer az összes adatot, társított objektumot és a szerkezetet is törli.

  • ALL_AGGREGATIONS

    – A rendszer az összes összesített adatot törli.
  • PARTIAL_DATA

    – A rendszer csak a megadott adatrégiót törli. Használat a -regionspec kapcsolóval.
-regionspec -rs Az eltávolítandó régiót meghatározó MDX-kifejezés.

Példa

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

Az adatok törlését a Cube Designer Adatok betöltése opciójával, az Essbase webes felületének a Feladatok opciójával vagy a REST API segítségével, illetve a MaxL szolgáltatás DBS-NAME adatbázis módosításának visszaállítása parancsával is végrehajthatja.

Createlocalconnection: JDBC-kapcsolat mentése

Az Essbase createlocalconnection CLI parancsa egy JDBC-kapcsolatot hoz létre, és azt helyileg tárolja. A parancs használatához szolgáltatásadminisztrátori vagy kiemelt felhasználói szerepkörrel kell rendelkeznie.

Leírás

A szolgáltatás adminisztrátorának ezt a parancsot kell használnia a helyi kapcsolat létrehozásához és mentéséhez, mielőtt bárki használhatná a CLI dataload vagy dimbuild parancsát a streaming beállítással. Továbbá be kell állítania egy EXTERNAL_CLASSPATH környezeti változót úgy, hogy az az adatbázis-illesztőprogram .jar fájljára mutasson (lásd:Dimenziók felépítése és adatok betöltése távoli adatbázisra mutató adatfolyam segítségével).

Szintaxis

createLocalConnection [-verbose] -name streamConnection -connectionstring  connectionString -user userName [-driver jdbcDriver] [-password password]
Beállítás Rövidítés Leírás
-verbose -v Részletes leírás megjelenítése
-name -N Kapcsolat neve
-connectionstring -cs JDBC-kapcsolódási karakterlánc. A formátum lehet a szolgáltatásnévvel, a következők szerint:
jdbc:oracle:thin:@host:port/service_name

vagy SID-vel, a következők szerint:

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

A fenti szintaxisformátumok az Oracle Database szolgáltatásra vonatkoznak. Tekintse meg a Példák szakaszt, ahol felsoroljuk a csatlakozási karakterlánc szintaxisának kisebb eltéréseit, ha más szolgáltatókat használ.

-user -u Felhasználónév
-driver -D JDBC-illesztőprogram. Ha nincs megadva, az Oracle-adatbázis lesz az alapértelmezett: oracle.jdbc.driver.OracleDriver
-password -p Jelszó (nem kötelező)

Ha hálózati kapcsolattal rendelkezik egy külső adatforrás és az Essbase szolgáltatás között, az a leghatékonyabb módszer, ha az Essbase webes felületén definiálja az alkalmazásszintű és globális kapcsolatokat és az adatforrásokat. Ezek a definíciók segítenek könnyedén "áthúzni" az adatokat a külső adatforrásból. Ha nem rendelkezik hálózati kapcsolattal az Essbase szolgáltatás és a külső adatforrás között, akkor a CLI segítségével átviheti az adatbetöltéseket vagy dimenziófelépítéseket. Ehhez először ezzel a paranccsal létre kell hoznia egy helyi kapcsolatot, majd ki kell adnia a dataload vagy dimbuild parancsot az átviteli beállítással.

Megjegyzések

A 21.4-es vagy újabb kiadásra való áttérés után a szolgáltatásadminisztrátornak újra létre kell hoznia minden mentett helyi kapcsolatot, amelyet egy korábbi kiadásban ezzel a paranccsal hoztak létre.

Példák

Ha a -driver és a jdbcDriver paraméter nincs megadva, akkor alapértelmezés szerint az Oracle adatbázis a feltételezett adatbázis.

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

Ha a -driver és a jdbcDriver paraméter nincs megadva, akkor alapértelmezés szerint az Oracle adatbázis a feltételezett adatbázis.

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

Ha a -driver és a jdbcDriver paraméter nincs megadva, akkor alapértelmezés szerint az Oracle adatbázis a feltételezett adatbázis.

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

Ha a -driver és a jdbcDriver paraméter nincs megadva, akkor alapértelmezés szerint az Oracle adatbázis a feltételezett adatbázis.

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

Ha a -driver és a jdbcDriver paraméter nincs megadva, akkor alapértelmezés szerint az Oracle adatbázis a feltételezett adatbázis.

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

Ha a -driver és a jdbcDriver paraméter nincs megadva, akkor alapértelmezés szerint az Oracle adatbázis a feltételezett adatbázis.

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

Dataload: Adatok betöltése a kockába

Az Essbase dataload CLI parancsa feltölti az adatokat a kockába. Ezen parancs használatához legalább Adatbázis-módosítási engedéllyel kell rendelkeznie.

Ehhez a parancshoz az alábbi beállítások valamelyikét kell használnia:

  • Adatfájl és opcionális szabályfájl

  • Szabályfájl felhasználónévvel és jelszóval

  • Mentett helyi kapcsolatra hivatkozó adatfolyam beállítás

A forrásadatbázisnak az ügyfélhálózaton belül elérhetőnek kell lennie, mivel nem minden adatbázis-illesztőprogram tud együttműködni a Java-proxykkal.

Az adatok betöltéséhez először fel kell töltenie az adatbetöltési és szabályfájlokat a kocka könyvtárába. A fájlok feltöltéséhez használja a CLI felületet. Lásd: Upload: Kockafájlok felvétele.

Szintaxis

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]
Beállítás Rövidítés Leírás
-verbose -v Részletes leírás megjelenítése
-application -a Alkalmazás neve
-db -d Az adatbázis (kocka) neve.
-file -f Adatbetöltési fájl neve. Nem kell megadnia a teljes elérési útvonalat. A rendszer úgy veszi, hogy a fájlok a releváns adatbázis könyvtárában találhatók. A jelenlegi opció helyett használhatja a -catalogfile opciót.
-rule -r Nem kötelező. A szabályfájl neve. Nem kell megadnia a teljes elérési útvonalat. A rendszer úgy veszi, hogy a fájlok a releváns adatbázis könyvtárában találhatók. A jelenlegi opció helyett használhatja a -catalogrulefile opciót.
-catalogfile -CF Az adatbetöltési fájl neve a fájlkatalógusból. Ezt az opciót a -file helyett használhatja.
-catalogrulefile -CRF A szabályfájl neve a fájlkatalógusból. Ezt az opciót a -rule helyett használhatja.
-user -u Nem kötelező. A felhasználónév. Ha bekapcsolja, a fájl jelszót fog kérni.

Ha mentett kapcsolatot és adatforrást használ, nem kell megadnia a felhasználónevét és a jelszavát. Ha nem mentett kapcsolatot használ, és a szabályfájl egy RDBMS-hez kapcsolódik, az RDBMS-hez való kapcsolódáshoz adja meg a felhasználónevét és a jelszavát.

-password -p Nem kötelező. A felhasználó jelszava. Ha kihagyja, a felhasználónak meg kell adnia a jelszót.
-stream -S Nem kötelező. Adatfolyamos adatbetöltés használata. Ha bekapcsolja, a -conn beállítást is használnia kell.
-connection -conn Kötelező, ha az adatfolyam beállítást használja. A createlocalconnection CLI-paranccsal létrehozott mentett kapcsolat neve.
-query -q Nem kötelező. Az adatfolyam adatainak betöltésével együtt elküldendő adatbázis-lekérdezés.
-rows -rows Nem kötelező. Az adatfolyamban egyidejűleg elküldendő sorok száma. Alapértelmezés: 100.
-abortOnError -abort Az adatbetöltés megszakítása, ha a rendszer hibát talál

Példák

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"

Az adatokat a Cube Designer, a Munkák az Essbase webes felületén vagy a REST API segítségével is betöltheti, vagy adatokat importálhat a MaxL-ben.

Deletefile: kocka fájljainak eltávolítása

Az Essbase deletefile CLI parancsa eltávolítja a kockamodellelemeket az alkalmazásból, az adatbázisból vagy a felhasználó kezdőkönyvtárából. Egy kocka fájljainak törléséhez legalább Adatbázis-kezelő engedéllyel kell rendelkeznie a kocka esetében. Nincs szükség speciális engedélyekre a felhasználói könyvtár fájljainak törléséhez.

Szintaxis

deletefile [-verbose] -file fileName [-application application [-db  database] [| -catalogfile catalogFile]]
Beállítás Rövidítés Leírás
-verbose -v Részletes leírás megjelenítése
-file -f A törlendő fájl neve
-application -a Nem kötelező. Az alkalmazás neve Ha nem adja meg, a rendszer úgy veszi, hogy a fájlok a felhasználó kezdőkönyvtárában vannak.
-database -db Nem kötelező. Az adatbázis (kocka) neve.
-catalogfile -CF A fájl elérési útja és neve a fájlkatalógusból. Ezt az opciót a -file helyett használhatja.

Példák

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

A fájlok kezelését végezheti a Cube Designer szolgáltatásból, az Essbase webes felületéről vagy a REST API segítségével is.

Deploy: kocka létrehozása munkafüzetből

Az Essbase deploy CLI parancsa törli létrehoz egy kockát egy Excel-alkalmazás munkafüzetéből. A parancs futtatásához legalább kiemelt felhasználói szerepkörrel kell rendelkeznie.

Szintaxis

deploy [-verbose] -file fileName [-application application [-database database] | -catalogfile catalogFile] [-restructureoption restructureOption] [-loaddata] [-recreateapplication] [-createfiles] [-executescript]
Beállítás Rövidítés Leírás
-verbose -v Részletes leírás megjelenítése
-file -f Az alkalmazásmunkafüzet-fájl neve
-application -a Nem kötelező. Az alkalmazás neve Ha nincs megadva, a rendszer az alkalmazás nevét a munkafüzetből veszi.
-database -db Nem kötelező. Az adatbázis (kocka) neve. Ha nincs megadva, a rendszer az adatbázis nevét a munkafüzetből veszi.
-catalogfile -CF Alkalmazás-munkafüzet a fájlkatalógusból. Ezt az opciót a -file helyett használhatja.
-loaddata -l Nem kötelező. Az adatok betöltése, ha az alkalmazás-munkafüzet adatmunkalapot tartalmaz. Ellenkező esetben a rendszer csak a metaadatokat importálja a kockába.
-restructureoption -R Nem kötelező. Kulcsszó, amely a kívánt átstrukturálási beállítást jelzi.

A blokktárolós kockákhoz elérhető beállítások:

  • ALL_DATA – Az összes adat megőrzése

  • NO_DATA – Nincs adatmegőrzés

  • LEAFLEVEL_DATA – A 0. szintű (levél szintű) adatok megőrzése

  • INPUT_DATA – Bemeneti adatok megőrzése

A összesítéstárolós kockákhoz elérhető beállítások:

  • ALL_DATA – Az összes adat megőrzése

  • NO_DATA – Nincs adatmegőrzés

-recreateapplication -ra Nem kötelező. Az alkalmazás újbóli létrehozása, ha már létezik
-createfiles -cf Nem kötelező. Hozza létre a kocka modellelemeit az Essbase szolgáltatásban található fájlkönyvtárban.
-executescript -e Nem kötelező. Számítási parancsfájlok futtatása. Csak abban az esetben alkalmazható, ha az alkalmazás-munkafüzet rendelkezik egy olyan számítási munkalappal, amelyben a Számítás végrehajtása Igen értékre van állítva a definíciók között.

Példák

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

A kockák telepítését a Cube Designer segítségével vagy az Essbase webes felületének Alkalmazások részében található Importálás opció használatával is elvégezheti.

Dimbuild: Dimenziók betöltése a kockába

Az Essbase dimbuild CLI parancsa feltölti a dimenziókat a kockába. A parancs futtatásához legalább adatbázis-kezelői engedélyre van szüksége a kocka esetében.

A dimenziók betöltése előtt először fel kell töltenie a dimenziófelépítési és szabályfájlokat az Essbase alkalmazásba. A fájlok feltöltéséhez használja a CLI felületet. Lásd: Upload: Kockafájlok felvétele.

Szintaxis

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]
Beállítás Rövidítés Leírás
-verbose -v Részletes leírás megjelenítése
-application -a Alkalmazás neve
-db -d Az adatbázis (kocka) neve.
-file -f A dimenziófelépítési fájl neve. Nem kell megadnia a teljes elérési útvonalat. A rendszer úgy veszi, hogy a fájlok a releváns alkalmazás vagy adatbázis könyvtárában találhatóak. A jelenlegi opció helyett használhatja a -catalogfile opciót.
-rule -r A szabályfájl neve. Nem kell megadnia a teljes elérési útvonalat. A rendszer úgy veszi, hogy a fájlok a releváns alkalmazás vagy adatbázis könyvtárában találhatóak. A jelenlegi opció helyett használhatja a -catalogrulefile opciót.
-catalogfile -CF A dimenziófelépítési fájl neve a fájlkatalógusból. Ezt az opciót a -file helyett használhatja.
-catalogrulefile -CRF A szabályfájl neve a fájlkatalógusból. Ezt az opciót a -rule helyett használhatja.
-user -u Nem kötelező. A felhasználónév. Ha bekapcsolja, a fájl jelszót fog kérni.

Ha mentett kapcsolatot és adatforrást használ, nem kell megadnia a felhasználónevét és a jelszavát. Ha nem mentett kapcsolatot használ, és a szabályfájl egy RDBMS-hez kapcsolódik, az RDBMS-hez való kapcsolódáshoz adja meg a felhasználónevét és a jelszavát.

-password -p Nem kötelező. A felhasználó jelszava. Ha kihagyja, a felhasználónak meg kell adnia a jelszót.
-stream -S Nem kötelező. Adatfolyamos dimenziófelépítés használata. Ha bekapcsolja, a -conn beállítást is használnia kell.
-connection -conn Kötelező, ha az adatfolyam beállítást használja. A createlocalconnection CLI-paranccsal létrehozott mentett kapcsolat neve.
-query -q Nem kötelező. Az adatfolyam dimenziófelépítésével együtt elküldendő adatbázis-lekérdezés.
-rows -rows Nem kötelező. Az adatfolyamban egyidejűleg elküldendő sorok száma. Alapértelmezés: 100.
-restructureOption -R

A szerkezetstruktúrára vonatkozó megőrzési beállításokat szabályozza.

Blokktárolós megoldás esetén a következő beállítások állnak rendelkezésre:

  • ALL_DATA: Az összes adat megőrzése a dimenziók betöltése során.
  • NO_DATA: Minden adat elvetése.
  • LEAFLEVEL_DATA: Csak a 0. szintű adatértékek megőrzése. Válassza ezt a lehetőséget, ha a számításhoz szükséges összes adat 0. szintű tagokban található. A rendszer a kocka átszervezése előtt az összes felső szintű blokkot törli. A kocka újraszámításakor a rendszer újra létrehozza a felső szintű blokkokat.
  • INPUT_DATA: Csak a bevitt adatok megőrzése.

Összesítéstárolós megoldás esetén a következő beállítások állnak rendelkezésre:

  • ALL_DATA: Az összes adat megőrzése a dimenziók betöltése során.
  • NO_DATA: Minden adat elvetése.
-forcedimbuild -F Folytassa a dimenziófelépítést még akkor is, ha más felhasználói tevékenységek vannak folyamatban. Ez megszakítja az aktív felhasználói munkameneteket.

Példák

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

A dimenziókat a Cube Designer, a Munkák az Essbase webes felületén vagy a REST API segítségével is betöltheti, vagy dimenziókat importálhat a MaxL-ben.

Download: Kockafájlok lekérése

Az Essbase download CLI parancsa letölti a kockához tartozó modellelemeket az egyik Essbase-példányból egy helyi könyvtárba.

Előfordulhat, hogy le kell töltenie a kockához tartozó szövegfájlokat, szabályfájlokat és számítási parancsfájlokat, hogy dolgozni tudjon rajtuk, vagy fel tudja őket tölteni egy másik kockához. A kockához tartozó modellelemek letöltéséhez legalább Adatbázis-módosítási engedéllyel kell rendelkeznie.

Szintaxis

download [-verbose] -file filename[ | -catalogfile catalogFile] [-application appname [-db cubename]] [-localdirectory path] [-overwrite] [-nocompression]
Beállítás Rövidítés Leírás
-verbose -v Részletes leírás megjelenítése
-file -f A letölteni kívánt fájl neve.
-application -a Nem kötelező. Az alkalmazás neve Ha nem adja meg, a rendszer a felhasználó kezdőkönyvtárából tölti le a modellelemeket.
-db -d Nem kötelező. Az adatbázis (kocka) neve.
-catalogfile -CF A fájlkatalógusban lévő fájl. Ezt az opciót a -file helyett használhatja.
-localdirectory -ld Nem kötelező. Egy helyi elérési útvonal.
-overwrite -o Nem kötelező. A meglévő fájl felülírása.
-nocompression -nc Nem kötelező. Adatátviteli tömörítés letiltása

Példák

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

A fájlok kezelését végezheti a Cube Designer szolgáltatásból, az Essbase webes felületéről vagy a REST API segítségével is.

Help: Parancs szintaxisának megjelenítése

Az Essbase help CLI parancsa parancsszintű súgót jelenít meg a konzolon vagy a terminálon.

Szintaxis

[command] -help | -h

Példák

esscs -help
esscs -h
esscs dataload -help

LcmExport: Kockafájlok biztonsági mentése

Az Essbase lcmexport CLI parancsa biztonsági másolatot készít az alkalmazásokról és a kockamodellelemekről egy Életciklus-kezelés (LCM) .zip fájlba, amelyet letölt a helyi gépére. Ezen parancs futtatásához legalább alkalmazáskezelői engedéllyel kell rendelkeznie.

Szintaxis

lcmExport [-verbose] -application appname|-allApp -zipfilename filename [-localDirectory path][-threads threadscount][-skipdata][-overwrite][-generateartifactlist][-include-server-level][-cube][-exportdata][-filetype][-exportpartitions][-exportfilters][-restEncryPassword]
Beállítás Rövidítés Leírás
-verbose -v Nem kötelező. Részletes leírások megjelenítése.
-application -a Az alkalmazás neve, amelyről biztonsági mentést kíván készíteni.
-allApp -aa Nem kötelező (kis- és nagybetűk megkülönböztetése). Ha az -application helyett használja, az összes alkalmazást egyetlen .zip fájlba exportálja. Az lcmimport parancs képes egyalkalmazásos .zip fájlokat vagy többalkalmazásos .zip fájlokat is fogadni.
-zipfilename -z Nem kötelező. A biztonsági mentés fájljait tartalmazó tömörített fájl neve.
-localdirectory -ld Nem kötelező. Egy helyi elérési útvonal. Ha nincs másként megadva, akkor a zip fájl az <Alkalmazáskönyvtár>/catalog/users/<felhasználónév> helyre kerül az Essbase-kiszolgálón.
-threads -T Nem kötelező. A létrehozni kívánt szálak száma párhuzamos exportálás esetén. Minimum: 10
-skipdata -skip Nem kötelező. A biztonsági mentés ne tartalmazza az adatokat.
-overwrite -o Nem kötelező. A meglévő biztonsági mentési fájl felülírása.
-generateartifactlist -gal Nem kötelező. Hozzon létre egy szövegfájlt, amely tartalmazza az exportált modellelemek teljes listáját. Ezt a szövegfájlt használhatja a modellelemek importálásának kezelésére. Például átrendezheti a lista modellelemeinek sorrendjét, hogy szabályozza azok importálási sorrendjét. Kihagyhatja néhány modellelem importálását úgy, hogy eltávolít vagy megjegyzésbe helyez elemeket a listában.
-include-server-level -isl Nem kötelező. Használjon globálisan definiált kapcsolatokat és adatforrásokat.
-cube -c Nem kötelező. Egyetlen kocka exportálása. Ez az opció meghatározható azokkal az opciókkal, hogy csak a következők kerüljenek exportálásra: adatok, adott típusú fájlok, partíciók vagy szűrők.
-exportdata -d Nem kötelező. Csak adatok exportálása.
-filetype -ft

Nem kötelező. Csak a megadott típusú fájlok exportálása. A támogatott fájltípusok közé tartoznak: OTL (szerkezet), TXT (szöveg), RUL (szabály), CSC (számítási parancsfájl), DTR (részletező kimutatás definíciója) és Excel (csak .xls fájlokat exportál, .xlsx fájlokat nem).

Példák:

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

Nem kötelező. Csak partíciódefiníciók exportálása.

Az Életciklus-kezelés (LCM) importálási műveletek (és a Migrációs segédprogram importálása) nem támogatottak az összevont partíciók migrálásához. Az összevont partíciókat manuálisan kell újra létrehozni a célponton.

-exportfilters -ef Nem kötelező. Csak biztonsági szűrők exportálása.
-restEncryPassword -encryPwd

Ha az alkalmazás titkosított, ez egy jelszó, amely megvédi a titkosított alkalmazást az áttelepítés során. A jelszó hossza 6–15 karakter lehet, és nem tartalmazhatja a következő különleges karakterek egyikét sem: ?=.,*!@#&()[{}]:;'/~$^+<>-

Figyelem: Ha elfelejti ezt a jelszót, nincs lehetőség a visszaállítására, ezáltal nem lehet importálni az alkalmazást.

Megjegyzések

Ezt a parancsot (és a többi CLI-parancsot) az Essbase gépén kívül is lehet használni, míg az LCM segédprogram futtatásához az Essbase gépe szükséges.

Példa

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

Példa Windows-parancsfájlra

Az lcmexportall.bat Windows-parancsfájl az összes alkalmazást abba az aktuális helyi könyvtárba exportálja, ahonnan a CLI meghívásra került.

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: Kockafájlok helyreállítása

Az lcmimport CLI parancs az Essbase programhoz visszaállítja a kocka modellelemét egy életciklus-kezelési (LCM) .zip fájlból. A parancs futtatásához az alkalmazást létrehozó kiemelt felhasználónak vagy a szolgáltatás adminisztrátorának kell lennie.

Szintaxis

lcmImport [-verbose] -zipfilename filename [-overwrite] [-targetappName targetApplicationName][-include-server-level][-artifactlist artifactList][-restEncryPassword]
Beállítás Rövidítés Leírás
-verbose -v Nem kötelező. Részletes leírás megjelenítése
-zipfilename -z A biztonsági mentés fájljait tartalmazó tömörített fájl neve.
-overwrite -o Nem kötelező. A célalkalmazás ismételt létrehozása.
-targetappName -ta Nem kötelező. Célalkalmazás neve, ha szeretné, hogy eltérjen a forrás nevétől.
-artifactlist -al Nem kötelező. Annak a fájlnak a neve, amely tartalmazza az importálandó modellelemek listáját. Ez a fájl létrehozható az lcmexport parancsból.

Modellelemek kihagyásához helyezzen megjegyzésbe vagy töröljön bejegyzéseket a listából. Például naplórekordok importálásának kihagyásához helyezze megjegyzésbe az adott sort az itt látható módon:

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

Az importálási sorrend szabályozásához rendezze át az import bejegyzéseket a szövegfájlban.

Az –overwrite használata esetén az importálási művelet törli és újból létrehozza az egész alkalmazást, és csak a listán lévő modellelemeket importálja. Az –overwrite használatának mellőzése esetén az importálási művelet tartalmazza a listában meghatározott modellelemeket anélkül, hogy hatást gyakorolna bármely más, a célalkalmazásban már meglévő modellelemre.

-include-server-level -isl Nem kötelező. Használjon globálisan definiált kapcsolatokat és adatforrásokat.
-restEncryPassword -encryPwd

Ha az alkalmazás titkosított, ez egy jelszó, amely megvédi a titkosított alkalmazást az áttelepítés során. A jelszó hossza 6–15 karakter lehet, és nem tartalmazhatja a következő különleges karakterek egyikét sem: ?=.,*!@#&()[{}]:;'/~$^+<>-

Figyelem: Ha elfelejti ezt a jelszót, nincs lehetőség a visszaállítására, ezáltal nem lehet importálni az alkalmazást.

Megjegyzések

  • Ezt a parancsot (és a többi CLI-parancsot) az Essbase gépén kívül is lehet használni, míg az LCM segédprogram futtatásához az Essbase gépe szükséges.

  • Az LCM-importálás befejezése után előfordulhat, hogy további lépéseket kell tennie a külső forrásokhoz átköltöztetett kapcsolatok visszaállításához. Ehhez nyissa meg a kapcsolatot, és adja meg a jelszót.

  • Ha az áttelepítendő kockák között partíciók vannak érvényben, az adatforrást kell előbb importálnia. Ellenkező esetben a rendszer nem tudja helyreállítani a partíciódefiníciókat.

    Az Életciklus-kezelés (LCM) importálási műveletek (és a Migrációs segédprogram importálása) nem támogatottak az összevont partíciók migrálásához. Az összevont partíciókat manuálisan kell újra létrehozni a célponton.

  • Az LCM importálása nem telepíti át a helyalias hitelesítő adatokat. Le kell cserélnie a helyalias hitelesítő adatait. Ezt úgy végezheti el, hogy újra létrehozza a helyaliasokat a MaxL használatával, vagy szerkeszti a helyalias hitelesítő adatokat az LCM exportálás által exportált XML-fájlban.

Példa

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

Listapp: Alkalmazások megjelenítése

A listapp CLI parancs azokat az alkalmazásokat sorolja fel, amelyekhez hozzáférési jogosultsága van az Essbase ezen példányán.

Szintaxis

listapp [-verbose] [-details]
Beállítás Rövidítés Leírás
-verbose -v Nem kötelező. Részletes leírás megjelenítése
-details -dtl Nem kötelező. Részletesebb eredmények megjelenítése (alkalmazás típusa és aktuális állapota).

Példa

esscs listapp -v -dtl

Listdb: Kockák megjelenítése

Ez a listdb CLI-parancs azokat az adatbázisokat sorolja fel, amelyekhez hozzáférési jogosultsága van egy adott Essbase alkalmazásban.

Szintaxis

listdb [-verbose] -application applicationName [details]
Beállítás Rövidítés Leírás
-verbose -v Nem kötelező. Részletes leírás megjelenítése
-application -a Alkalmazás neve
-details -dtl Nem kötelező. Állapotadatok megjelenítése az eredményekben

Példa

esscs listdb -v -a Sample -dtl

Listfiles: Fájlok megjelenítése

A listfiles CLI parancs az Essbase példányában létező kockamodellelemeket sorolja fel.

A kockához tartozó modellelemek közé sorolhatók az adatfájlok, munkafüzetek, szabályfájlok, számítási parancsfájlok és egyéb modellelemek. A kockához tartozó modellelemek közé tartozik minden olyan fájl, amelyre szükség van ahhoz, hogy műveleteket lehessen végezni az alkalmazásokon és a kockákon.

Egy kocka fájljainak listázásához legalább adatbázis-hozzáférési engedélyre van szüksége az alkalmazásban. Nincs szükség speciális engedélyekre a felhasználói könyvtár fájljainak felsorolásához.

Szintaxis

listfiles [-verbose] [-type filetype] [-application appname [-db cubename] | -catalogpath catalogPath] 
Beállítás Rövidítés Leírás
-verbose -v Nem kötelező. Részletes leírás megjelenítése
-type -t Nem kötelező. A megjelenítendő fájlkiterjesztés/-típus (pont nélkül).

Támogatott fájltípusok:

  • .csc (számítási parancsfájlok)
  • .rul (szabályfájlok)
  • .txt (szövegfájlok)
  • .msh (MaxL-parancsfájlok)
  • .xls, .xlsx (Excel-munkafüzetek)
  • .xlsm (makrókompatibilis Excel-munkafüzetek)
  • .xml (XML-fájlok)
  • .zip (tömörített, .zip-fájlok)
  • .csv (vesszővel tagolt fájlok)
-application -a Nem kötelező. Az alkalmazás neve Ha nem adja meg, a rendszer a felhasználó kezdőkönyvtárából jeleníti meg a fájlokat.
-db -d Nem kötelező. Az adatbázis (kocka) neve.
-catalogpath -CP Nem kötelező. A katalógus elérési útja a fájlnévhez. A -a [-d] helyett használható a fájlokhoz tartozó katalógus helyének megadására.

Példák

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

A fájlok kezelését végezheti a Cube Designer szolgáltatásból, az Essbase webes felületéről vagy a REST API segítségével is.

Listfilters: Biztonsági szűrők megtekintése

A listfilters CLI parancs megjeleníti az Essbase biztonsági szűrőinek listáját. Legalább Adatbázis-kezelői engedéllyel kell rendelkeznie az alkalmazáshoz ahhoz, hogy az alkalmazásban lévő bármelyik kocka szűrőit megtekinthesse.

Szintaxis

listfilters [-verbose] -application appname -db cubename 
Beállítás Rövidítés Leírás
-verbose -v Nem kötelező. Részletes leírás megjelenítése
-application -a Alkalmazás neve
-db -d Az adatbázis (kocka) neve.

Példa

esscs listfilters -v -a Sample -d Basic 

Listlocks: Zárolások megtekintése

Az Essbase listlocks CLI parancsa az összes zárolt adatblokkot vagy kockához kapcsolódó objektumot megjeleníti. A parancs futtatásához legalább adatbázis-hozzáférési engedélyre van szüksége az alkalmazásban.

Szintaxis

listlocks [-verbose] -application appname -db cubename [-object] 
Beállítás Rövidítés Leírás
-verbose -v Nem kötelező. Részletes leírás megjelenítése
-application -a Alkalmazás neve
-db -d Az adatbázis (kocka) neve.
-object -obj Nem kötelező. Zárolt fájlok/modellelemek megjelenítése.

Példa

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

Listvariables: a helyettesítési változók megjelenítése

Az Essbase listvariables CLI parancsa a kockában, alkalmazásban vagy globális hatókörben meghatározott helyettesítő változókat sorolja fel. Legalább Adatbázis-hozzáférési engedéllyel kell rendelkeznie egy kocka változóinak megtekintéséhez, Alkalmazáskezelő szerepkörrel egy alkalmazás változóinak megtekintéséhez, illetve Szolgáltatás-rendszergazda szerepkörrel a globális változók megtekintéséhez.

Szintaxis

listvariables [-verbose] [-application application [-db database]]
Beállítás Rövidítés Leírás
-verbose -v Részletes leírások megjelenítése.
-application -a Nem kötelező. Az alkalmazás neve
-database -db Nem kötelező. Az adatbázis (kocka) neve.

Példák

Kockaszint

esscs listvariables -a Sample -db Basic

Alkalmazásszint

esscs listvariables -a Sample

Globális szint

esscs listvariables

Setpassword: CLI hitelesítő adatok tárolása

Az Essbase setpassword CLI parancsa eltárolja a kliens/felhasználó kombinációjához társított jelszót. A következő munkamenetekben jelszó megadása nélkül jelentkezhet be.

Szintaxis

 setpassword [-verbose] -essbaseurl URL -user userName
Beállítás Rövidítés Leírás
-verbose -v Nem kötelező. Részletes leírás megjelenítése
-essbaseurl -url Az Essbase egy példányának címe
-user -u Az Ön felhasználóneve

Megjegyzések

A 21.4-es vagy újabb kiadásra való áttelepítés után vissza kell állítania minden tárolt jelszót, amelyet egy korábbi kiadásban ezzel a paranccsal mentett.

Példa

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

Start: Alkalmazás vagy kocka indítása

A start CLI parancs elindít egy Essbase alkalmazást vagy kockát, és betölti a memóriába. A parancs futtatásához legalább adatbázis-hozzáférési engedélyre van szüksége az alkalmazásban.

Szintaxis

start [-verbose] -application appname [-db cubename]
Beállítás Rövidítés Leírás
-verbose -v Nem kötelező. Részletes leírás megjelenítése
-application -a Alkalmazás neve
-db -d Nem kötelező. Az adatbázis (kocka) neve.

Példa

esscs start -v -a Sample -d Basic

Stop: Alkalmazás vagy kocka leállítása

A stop CLI parancs leállítja az Essbase alkalmazást vagy a kockát. A parancs futtatásához legalább adatbázis-hozzáférési engedélyre van szüksége az alkalmazásban.

Szintaxis

stop [-verbose] -application appname [-db cubename]
Beállítás Rövidítés Leírás
-verbose -v Nem kötelező. Részletes leírás megjelenítése
-application -a Alkalmazás neve
-db -d Nem kötelező. Az adatbázis (kocka) neve.

Példa

esscs stop -v -a Sample -d Basic 

Unsetpassword: A tárolt CLI hitelesítő adatok eltávolítása

Az Essbase unsetpassword CLI parancsa eltávolítja a kliens/felhasználó kombinációhoz társított tárolt bejelentkezési adatokat, megfordítva a setpassword hatását.

Szintaxis

unsetpassword [-verbose] -essbaseurl URL -user userName
Beállítás Rövidítés Leírás
-verbose -v Részletes leírás megjelenítése
-essbaseurl -url Az Essbase egy példányának címe
-user -u A felhasználó, akinek a jelszava beállítását törölni kell

Példa

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

Upload: Kockafájlok felvétele

Az upload CLI parancs kockamodellelemeket tölt fel egy helyi könyvtárból az Essbase egy példányába.

Ahhoz, hogy el tudja végezni az adatbetöltést, a dimenziófelépítést, valamint számításokat vagy más műveleteket tudjon végrehajtani, előfordulhat, hogy fel kell töltenie adatfájlokat, szabályfájlokat, számítási parancsfájlokat vagy egyéb modellelemeket a kocka könyvtárába. A modellelemeket a felhasználói könyvtárába is feltöltheti.

Egy kocka fájljainak feltöltéséhez legalább Adatbázis-kezelő engedéllyel kell rendelkeznie. Nincs szükség speciális engedélyekre a felhasználói könyvtárba való feltöltéshez.

Megjegyzés:

Az Essbase webes felületén beállíthatja a víruskeresés engedélyezését úgy, hogy a fájlok vírusellenőrzésre kerüljenek, mielőtt feltöltődnek a kiszolgálóra.

Szintaxis

upload [-verbose] -file filename [-application appname [-db cubename] | -catalogpath catalogPath] [-overwrite] [-nocompression][-compressionalgorithm]
Beállítás Rövidítés Leírás
-verbose -v Nem kötelező. Részletes leírás megjelenítése
-file -f A feltöltendő fájl neve

Megjegyzés:

A fájlkiterjesztéseknek kisbetűsnek kell lenniük. Például: fájlnév.txt.
-application -a Nem kötelező. Az alkalmazás neve Ha nincs megadva, akkor a fájlok a felhasználói könyvtárba töltődnek fel, vagy pedig a -CP paraméterben megadott katalógus-elérési útvonalra.
-db -d Nem kötelező. Az adatbázis (kocka) neve. A -a paraméter szükséges.
-catalogpath -CP Nem kötelező. A katalógus elérési útja a fájlnévhez. A -a [-d] helyett használható a fájlhoz tartozó katalógus helyének megadására.
-overwrite -o Nem kötelező. A meglévő fájl felülírása.
-nocompression -nc Nem kötelező. Adatátviteli tömörítés letiltása
-compressionalgorithm -ca Nem kötelező. Akkor érhető el, ha a -nc paramétert nem használják. Meghatározza, hogy a rendszer melyik tömörítési algoritmust használja az adatátvitelhez. Választható lehetőségek: gzip vagy lz4.
  • gzip—alapértelmezett, ha tömörítést használnak. Kevesebb számítást és kisebb adatátvitelt biztosít.

  • lz4—gyorsabb számítást és lassúbb adatátvitelt biztosít.

Példák a használatára:

-ca gzip
-ca lz4

Példák

esscs upload -v -f c:/temp/Maxl01.msh -a Sample -d Basic -o -ca lz4
esscs upload -f C:/temp/Act1.rul -CP /shared

A fájlok kezelését végezheti a Cube Designer szolgáltatásból, az Essbase webes felületéről vagy a REST API segítségével is.

Version: API verziószámának megjelenítése

A version CLI parancs a REST API azon verzióját kapja meg, amely az Essbase ezen példányához van társítva.

Szintaxis

version

Példa

esscs version