Referinţă pt. comenzile CLI

Comenzile CLI Essbase CLI pe care le emiteţi în interpretorul de comenzi esscs vă ajută să efectuaţi operaţiuni de rutină pe platformă, inclusiv calc, dataload, dimbuild, lcmexport, lcmimport, încărcarea şi descărcarea artefactelor, pornirea şi oprirea unei aplicaţii sau a unui cub şi multe altele.

Următoarele comenzi sunt disponibile în interfaţa în linie de comandă. Argumentele pt. comenzi pot fi emise în orice ordine.

Pentru a afişa asistenţa pt. toate comenzile, introduceţi esscs -h. Pentru a afişa asistenţa pt. o anumită comandă, introduceţi esscs comanda -h.

Pentru a activa rezultatul prolix pt. orice comandă, adică afişarea informaţiilor extinse (dacă sunt disponibile), introduceţi esscs comanda -v argumente comanda.

Conectare/Deconectare: Autentificare CLI

Comanda login din CLI pentru Essbase vă autentifică în Essbase pentru a putea utiliza interfaţa în linie de comandă.

Pentru a putea emite alte comenzi CLI pentru Essbase, trebuie să vă conectaţi. Dacă este obligatorie o conexiune securizată, URL-ul trebuie să înceapă cu https.

Vă puteţi autentifica în următoarele moduri folosind CLI:

  • Utilizaţi setpassword o dată pentru a stoca parola pentru combinaţia client/utilizator. În sesiunile ulterioare, puteţi utiliza comanda login fără a vi se solicita să introduceţi o parolă.
  • Utilizaţi opţiunile -user şi -password cu comanda login (Atenţie: parola apare necriptată în fereastra shell).
  • Utilizaţi numai opţiunea -user cu comanda login. Vi se solicită să introduceţi parola, care este ascunsă.

Dacă sunteţi un utilizator SSO distribuit în Oracle Identity Cloud Service, conectarea utilizând MaxL sau CLI nu este acceptată. Conectarea SSO distribuită necesită o fereastră de browser. Creaţi un utilizator Identity Cloud Service nativ şi utilizaţi-l pentru a vă conecta utilizând MaxL sau CLI.

Sintaxa (conectarea)

login [-verbose] -essbaseurl https://instance-name.example.com/essbase -user username [-password password]
Opţiune Abreviere Descriere
-verbose -v Afişaţi descrierile extinse
-essbaseurl -url Adresa unei instanţe a Essbase
-user -u Numele de utilizator
-password -p Opţional. Parola pt. utilizator. Alternativ, setaţi parola utilizând setpassword.

Dacă emiteţi comanda de conectare dintr-un script, iar parola conţine caractere speciale, încadraţi-le între ghilimele duble (de exemplu, "aNb3^5%9$!").

Utilizarea caracterului $ (semnul pentru dolar) în parola Essbase nu este acceptată pentru conectările într-un mediu Linux.

Exemplu 1 (conectarea)

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

Exemplu 2 (conectarea)

În următorul exemplu, utilizatorul care se conectează, admin1@example.com, este un administrator Identity Cloud Service care a fost setat drept administrator iniţial Essbase pe parcursul implementării stivei Essbase în infrastructura Oracle Cloud. Deoarece parola nu este introdusă în acest exemplu, administratorului i se va solicita ulterior să o introducă. URL-ul este essbase_url din rezultatele jobului generat de implementarea stivei.

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

Sintaxa (deconectarea)

logout

Exemplu (deconectarea)

esscs logout

Calc: Rularea unui script de calcul

Comanda calc din CLI pentru Essbase execută un script de calcul asupra cubului. Pentru a rula această comandă, aveţi nevoie cel puţin de permisiunea Actualizare bază de date, precum şi de accesul alocat pentru scriptul de calcul.

Pentru a putea rula script-uri de calcul, mai întâi trebuie să încărcaţi script-urile, ca fişiere .csc, în directorul cubului. Puteţi utiliza CLI pt. a încărca fişiere. Consultaţi Upload: Adăugarea fişierelor de cuburi.

Sintaxă

calc [-verbose] -application appname -db cubename -script scriptfilename
Opţiune Abreviere Descriere
-verbose -v Afişaţi descrierile extinse
-application -a Numele aplicaţiei
-db -d Numele bazei de date (cubului)
-script -s Numele scriptului de calcul. Trebuie să aibă extensia de fişier .csc. Nu trebuie să introduceţi calea integrală. Se presupune că fişierele sunt în directorul cubului relevant.

Exemplu

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

De asemenea, puteţi rula script-uri de calcul utilizând opţiunea Calculare din Cube Designer sau Smart View, Joburi din interfaţa web Essbase sau API-ul REST, ori execute calculation în MaxL.

Clear: Eliminarea datelor dintr-un cub

Comanda clear din CLI pentru Essbase goleşte datele dintr-un cub. Pentru a utiliza această comandă, aveţi nevoie cel puţin de permisiunea Actualizare bază de date.

Sintaxă

clear [-verbose] -application appname -db cubename [-option clearOption[-regionspec regionSpec]]
Opţiune Abreviere Descriere
-verbose -v Opţional. Afişaţi descrierile extinse
-application -a Numele aplicaţiei
-db -d Numele bazei de date (cubului)
-option -O Opţional. Cuvântul cheie ce specifică ce se elimină. Opţiunea prestabilită, dacă este omisă, este ALL_DATA.

Opţiunile pentru cuburile de stocare a blocurilor sunt:

  • ALL_DATA - Toate datele, obiectele legate şi structura sunt eliminate

  • UPPER_LEVEL — Blocurile de la nivelul superior sunt golite

  • NON_INPUT — Blocurile fără introducere sunt golite

Opţiunile pentru cuburile de stocare agregări sunt:

  • ALL_DATA - Toate datele, obiectele legate şi structura sunt eliminate

  • ALL_AGGREGATIONS

    - Toate datele agregate sunt eliminate

  • PARTIAL_DATA

    - Doar regiunea de date specificată este eliminată. Utilizaţi cu -regionspec
-regionspec -rs Expresia MDX ce specifică regiunea de eliminat

Exemplu

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

De asemenea, puteţi goli datele utilizând opţiunea Încărcare date din Cube Designer, Joburi din interfaţa web Essbase sau API-ul REST, sau instrucţiunea alter database DBS-NAME reset în MaxL.

Createlocalconnection: Salvarea unei conexiuni JDBC

Comanda createlocalconnection din CLI pentru Essbase creează o conexiune JDBC şi o stochează local. Pentru a utiliza această comandă, aveţi nevoie de rolul de administrator de serviciu sau utilizator avansat.

Descriere

Administratorul serviciului trebuie să utilizeze această comandă pentru a crea şi a salva conexiunea locală, pentru ca utilizatorii să poată utiliza în CLI comanda dataload sau dimbuild cu opţiunea streaming. De asemenea, trebuie să setaţi o variabilă de mediu EXTERNAL_CLASSPATH pentru a indica fişierul .jar pentru driverul bazei dvs. de date (consultaţi Generarea dimensiunilor şi încărcarea datelor redând în flux dintr-o bază de date la distanţă).

Sintaxă

createLocalConnection [-verbose] -name streamConnection -connectionstring  connectionString -user userName [-driver jdbcDriver] [-password password]
Opţiune Abreviere Descriere
-verbose -v Afişaţi descrierile extinse
-name -N Nume conexiune
-connectionstring -cs Şirul de conectare JDBC. Formatul poate fi cu numele serviciului, după cum urmează: 
jdbc:oracle:thin:@host:port/service_name

sau cu SID, după cum urmează:

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

Formatele sintaxei de mai sus se aplică pentru Oracle Database. Consultaţi secţiunea Exemple pentru a vedea diferenţele minore din sintaxa şirului de conectare când lucraţi cu alţi furnizori.
-user -u Numele de utilizator
-driver -D Driverul JDBC. Dacă nu este introdus, Oracle Database este luată în considerare ca valoare prestabilită, ca în oracle.jdbc.driver.OracleDriver
-password -p Parolă (Opţională)

Dacă aveţi conectivitate prin reţea între o sursă de date externă şi Essbase, este mai eficient să definiţi conexiuni la nivel de aplicaţie sau globale şi surse de date în interfaţa web Essbase. Aceste definiţii vă ajută să "preluaţi" cu uşurinţă date din sursa externă. Dacă nu aveţi conectivitate prin reţea între Essbase şi sursa externă de date, puteţi transmite în flux încărcările de date sau generările de dimensiuni utilizând instrumentul CLI: Creaţi mai întâi o conexiune locală, apoi emiteţi încărcarea de date sau generarea de dimensiuni cu opţiunea de transmitere în flux.

Note

După migrarea la versiunea 21.4 sau alta ulterioară, administratorul serviciului trebuie să recreeze toate conexiunile locale salvate, care au fost create utilizând această comandă într-o versiune anterioară.

Exemple

Dacă opţiunea -driver şi parametrul jdbcDriver nu sunt introduse, se presupune că baza de date prestabilită este baza de date Oracle.

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

Dacă opţiunea -driver şi parametrul jdbcDriver nu sunt introduse, se presupune că baza de date prestabilită este baza de date Oracle.

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

Dacă opţiunea -driver şi parametrul jdbcDriver nu sunt introduse, se presupune că baza de date prestabilită este baza de date Oracle.

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

Dacă opţiunea -driver şi parametrul jdbcDriver nu sunt introduse, se presupune că baza de date prestabilită este baza de date Oracle.

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

Dacă opţiunea -driver şi parametrul jdbcDriver nu sunt introduse, se presupune că baza de date prestabilită este baza de date Oracle.

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

Dacă opţiunea -driver şi parametrul jdbcDriver nu sunt introduse, se presupune că baza de date prestabilită este baza de date Oracle.

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

Dataload: Încărcarea datelor într-un cub

Comanda dataload din CLI pentru Essbase încarcă date într-un cub. Pentru a utiliza această comandă, aveţi nevoie cel puţin de permisiunea Actualizare bază de date.

Această comandă necesită unul dintre următoarele seturi de opţiuni:

  • Fişier de date şi fişier de reguli opţional

  • Fişier de reguli cu nume de utilizator şi parolă

  • Opţiunea Stream, care referă o conexiune locală salvată

Baza de date sursă trebuie să fie accesibilă din cadrul reţelei client, deoarece nu toate driverele bazei de date funcţionează cu proxy-uri Java.

Pentru a încărca date, trebuie mai întâi să încărcaţi încărcarea de date şi fişierele de reguli în directorul cubului. Puteţi utiliza CLI pt. a încărca fişiere. Consultaţi Upload: Adăugarea fişierelor de cuburi.

Sintaxă

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]
Opţiune Abreviere Descriere
-verbose -v Afişaţi descrierile extinse
-application -a Numele aplicaţiei
-db -d Numele bazei de date (cubului)
-file -f Numele fişierului de încărcare a datelor. Nu trebuie să introduceţi calea integrală. Se presupune că fişierele sunt în directorul bazei de date relevante. Puteţi utiliza -catalogfile în locul acestei opţiuni.
-rule -r Opţional. Nume fişier de reguli. Nu trebuie să introduceţi calea integrală. Se presupune că fişierele sunt în directorul bazei de date relevante. Puteţi utiliza -catalogrulefile în locul acestei opţiuni.
-catalogfile -CF Numele fişierului de încărcare date din catalogul de fişiere. Puteţi utiliza această opţiune în loc de -file.
-catalogrulefile -CRF Numele fişierului de reguli din catalogul de fişiere. Puteţi utiliza această opţiune în loc de -rule.
-user -u Opţional. Numele de utilizator. Necesită parolă dacă este utilizată.

Dacă utilizaţi o conexiune şi o sursă de date salvată, nu sunt necesare numele şi parola. Dacă nu utilizaţi o conexiune salvată, iar fişierul de reguli se conectează la un server RDBMS, specificaţi numele de utilizator şi parola pentru conectarea la serverul RDBMS.
-password -p Opţional. Parola pt. utilizator. Dacă este omisă, utilizatorului i se va solicita parola.
-stream -S Opţional. Utilizaţi transmiterea în flux a încărcării datelor. Necesită opţiunea -conn dacă este utilizată.
-connection -conn Obligatorie dacă este utilizată opţiunea streaming. Numele unei conexiuni salvate, care a fost creată utilizând comanda CLI createlocalconnection.
-query -q Opţional. Interogarea bazei de date, de trimis împreună cu o încărcare a datelor cu transmitere în flux.
-rows -rows Opţional. Nr. de rânduri de transmis în flux simultan. Valoarea prestabilită este 100.
-abortOnError -abort Abandonaţi încărcarea datelor dacă este întâlnită o eroare

Exemple

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"

De asemenea, puteţi încărca date utilizând Cube Designer, Joburi în interfaţa web Essbase sau API-ul REST, ori import date în MaxL.

Deletefile: Eliminarea fişierelor cubului

Comanda deletefile din CLI pentru Essbase elimină artefactele de tip cub din aplicaţia, baza de date sau directorul home al utilizatorului. Pentru a şterge fişierele dintr-un cub, aveţi nevoie cel puţin de permisiunea "Manager bază de date" pt. cub. Nu sunt necesare permisiuni speciale pentru a şterge fişierele din directorul dvs. de utilizator.

Sintaxă

deletefile [-verbose] -file fileName [-application application [-db  database] [| -catalogfile catalogFile]]
Opţiune Abreviere Descriere
-verbose -v Afişaţi descrierile extinse
-file -f Numele fişierului de şters
-application -a Opţional. Numele aplicaţiei. Dacă nu sunt introduse, se presupune că fişierele sunt încărcate în directorul home de utilizator.
-database -db Opţional. Numele bazei de date (cubului)
-catalogfile -CF Calea fişierului şi numele din catalogul de fişiere. Puteţi utiliza această opţiune în loc de -file.

Exemple

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

De asemenea, puteţi administra fişiere în Cube Designer, în interfaţa web Essbase sau în API-ul REST.

Deploy: Crearea unui cub dintr-un registru de calcul

Comanda deploy din CLI pentru Essbase creează un cub dintr-un registru de calcul al aplicaţiei Excel. Pentru a rula această comandă, aveţi nevoie cel puţin de rolul Utilizator avansat.

Sintaxă

deploy [-verbose] -file fileName [-application application [-database database] | -catalogfile catalogFile] [-restructureoption restructureOption] [-loaddata] [-recreateapplication] [-createfiles] [-executescript]
Opţiune Abreviere Descriere
-verbose -v Afişaţi descrierile extinse
-file -f Numele fişierului registru de calcul al aplicaţiei
-application -a Opţional. Numele aplicaţiei. Dacă nu este introdus, numele aplicaţiei va fi preluat din registrul de calcul.
-database -db Opţional. Numele bazei de date (cubului). Dacă nu este introdus, numele bazei de date va fi preluat din registrul de calcul.
-catalogfile -CF Registrul de lucru al aplicaţiei din catalogul de fişiere. Puteţi utiliza această opţiune în loc de -file.
-loaddata -l Opţional. Încărcaţi datele, dacă registrul de calcul al aplicaţiei conţine o foaie de calcul pt. date. În caz contrar, doar metadatele sunt importate în cub.
-restructureoption -R Opţional. Cuvânt cheie care indică opţiunea de restructurare dorită.

Opţiunile pentru cuburile de stocare a blocurilor sunt:

  • ALL_DATA—Păstrare toate datele

  • NO_DATA—Nu se păstrează date

  • LEAFLEVEL_DATA—Sunt păstrate valorile de nivel 0 (nivel frunză)

  • INPUT_DATA—Păstrare date de intrare

Opţiunile pentru cuburile de stocare agregări sunt:

  • ALL_DATA—Păstrare toate datele

  • NO_DATA—Nu se păstrează date
-recreateapplication -ra Opţional. Re-creaţi aplicaţia, dacă aceasta există deja
-createfiles -cf Opţional. Creaţi artefactele cubului în directorul de fişiere din Essbase.
-executescript -e Opţional. Se execută scripturile de calcul. Aplicabil numai dacă registrul de lucru al aplicaţiei conţine o foaie de calcul cu Executare calcul setată la Da în definiţii.

Exemple

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

De asemenea, puteţi implementa cuburi utilizând Cube Designer sau utilizând opţiunea Import din secţiunea Aplicaţii a interfeţei web Essbase.

Dimbuild: Încărcarea dimensiunilor într-un cub

Comanda dimbuild din CLI pentru Essbase încarcă dimensiuni într-un cub. Pentru a rula această comandă, aveţi nevoie cel puţin de permisiunea Manager bază de date pentru cub.

Pentru a putea încărca dimensiuni, mai întâi trebuie să încărcaţi fişierele de generare a dimensiunilor şi fişierele de reguli în Essbase. Puteţi utiliza CLI pt. a încărca fişiere. Consultaţi Upload: Adăugarea fişierelor de cuburi.

Sintaxă

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]
Opţiune Abreviere Descriere
-verbose -v Afişaţi descrierile extinse
-application -a Numele aplicaţiei
-db -d Numele bazei de date (cubului)
-file -f Numele fişierului de generare a dimensiunilor. Nu trebuie să introduceţi calea integrală. Se presupune că fişierele sunt în directorul aplicaţiei sau bazei de date relevante. Puteţi utiliza -catalogfile în locul acestei opţiuni.
-rule -r Nume fişier de reguli. Nu trebuie să introduceţi calea integrală. Se presupune că fişierele sunt în directorul aplicaţiei sau bazei de date relevante. Puteţi utiliza -catalogrulefile în locul acestei opţiuni.
-catalogfile -CF Numele fişierului de generare dimensiuni din catalogul de fişiere. Puteţi utiliza această opţiune în loc de -file.
-catalogrulefile -CRF Numele fişierului de reguli din catalogul de fişiere. Puteţi utiliza această opţiune în loc de -rule.
-user -u Opţional. Numele de utilizator. Necesită parolă dacă este utilizată.

Dacă utilizaţi o conexiune şi o sursă de date salvată, nu sunt necesare numele şi parola. Dacă nu utilizaţi o conexiune salvată, iar fişierul de reguli se conectează la un server RDBMS, specificaţi numele de utilizator şi parola pentru conectarea la serverul RDBMS.
-password -p Opţional. Parola pt. utilizator. Dacă este omisă, utilizatorului i se va solicita parola.
-stream -S Opţional. Utilizaţi generarea în flux a dimensiunilor. Necesită opţiunea -conn dacă este utilizată.
-connection -conn Obligatorie dacă este utilizată opţiunea streaming. Numele unei conexiuni salvate, care a fost creată utilizând comanda CLI createlocalconnection.
-query -q Opţional. Interogarea bazei de date, de trimis împreună cu generarea dimensiunilor cu transmitere în flux.
-rows -rows Opţional. Nr. de rânduri de transmis în flux simultan. Valoarea prestabilită este 100.
-restructureOption -R

Controlează opţiunile dvs. de păstrare pt. restructurarea structurii.

Pentru stocarea de blocuri, opţiunile posibile sunt:

  • ALL_DATA: Păstraţi toate datele la încărcarea dimensiunilor.
  • NO_DATA: Nu păstraţi datele.
  • LEAFLEVEL_DATA: Păstraţi doar valorile datelor de nivel 0. Dacă toate datele necesare calculării rezidă în membri de nivel 0, trebuie să selectaţi această opţiune. Toate blocurile de nivel superior sunt şterse înainte de restructurarea cubului. Când cubul este recalculat, blocurile de nivel superior sunt re-create.
  • INPUT_DATA: Păstraţi doar datele de intrare.

Pentru stocarea de agregări, opţiunile posibile sunt:

  • ALL_DATA: Păstraţi toate datele la încărcarea dimensiunilor.
  • NO_DATA: Nu păstraţi datele.
-forcedimbuild -F Continuaţi cu generarea dimensiunii chiar dacă sunt în derulare şi alte activităţi. Acest lucru va anula sesiunile de utilizator active.

Exemple

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

De asemenea, puteţi încărca dimensiunile utilizând Cube Designer, Joburi în interfaţa web Essbase sau API-ul REST, ori import dimensiuni în MaxL.

Download: Preluarea fişierelor cuburilor

Comanda download din CLI pentru Essbase descarcă artefactele de tip cub dintr-o instanţă a Essbase într-un director local.

Ar putea fi necesar să descărcaţi fişiere text, fişiere de reguli sau fişiere script de calcul dintr-un cub, pt. a putea lucra la ele sau a le putea încărca în alt cub. Pentru a descărca artefactele cuburilor, aveţi nevoie cel puţin de permisiunea "Actualizare bază de date".

Sintaxă

download [-verbose] -file filename[ | -catalogfile catalogFile] [-application appname [-db cubename]] [-localdirectory path] [-overwrite] [-nocompression]
Opţiune Abreviere Descriere
-verbose -v Afişaţi descrierile extinse
-file -f Numele fişierului de descărcat
-application -a Opţional. Numele aplicaţiei. Dacă nu este introdus, artefactele sunt descărcate din directorul home al utilizatorului dvs.
-db -d Opţional. Numele bazei de date (cubului)
-catalogfile -CF Fişier din catalogul de fişiere. Puteţi utiliza această opţiune în loc de -file.
-localdirectory -ld Opţional. Calea unui director local
-overwrite -o Opţional. Suprascrieţi fişierul existent
-nocompression -nc Opţional. Dezactivaţi comprimarea transferului de date

Exemple

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

De asemenea, puteţi administra fişiere în Cube Designer, în interfaţa web Essbase sau în API-ul REST.

Help: Afişarea sintaxei comenzilor

Comanda help din CLI pentru Essbase afişează asistenţa la nivel de comandă, în consolă sau în terminal.

Sintaxă

[command] -help | -h

Exemple

esscs -help
esscs -h
esscs dataload -help

LcmExport: Crearea copiilor de siguranţă ale fişierelor cuburilor

Comanda lcmexport din CLI pentru Essbase generează o copie de siguranţă a artefactelor de tip aplicaţie şi a celor de tip cub într-un fişier Lifecycle Management (LCM) .zip, pe care o descarcă în computerul dvs. local. Pentru a rula această comandă, aveţi nevoie cel puţin de permisiuni de acces la managerul de aplicaţii.

Sintaxă

lcmExport [-verbose] -application appname|-allApp -zipfilename filename [-localDirectory path][-threads threadscount][-skipdata][-overwrite][-generateartifactlist][-include-server-level][-cube][-exportdata][-filetype][-exportpartitions][-exportfilters][-restEncryPassword]
Opţiune Abreviere Descriere
-verbose -v Opţional. Afişează descrieri extinse.
-application -a Numele aplicaţiei pt. care este creată copia de siguranţă.
-allApp -aa Opţional (şi ţine cont de litere mari/mici). Dacă se utilizează în locul opţiunii -application, exportă toate aplicaţiile într-un singur fişier zip. Comanda lcmimport poate accepta fişiere zip pentru o singură aplicaţie sau fişiere zip pentru mai multe aplicaţii.
-zipfilename -z Opţional. Numele fişierului comprimat pt. stocarea fişierelor copii de siguranţă.
-localdirectory -ld Opţional. Calea unui director local. Dacă nu este specificat, fişierul zip este salvat în <Application Directory>/catalog/users/<user_name> pe serverul Essbase.
-threads -T Opţional. Numărul de fire de generat la utilizarea exportului paralel. Minim: 10
-skipdata -skip Opţional. Nu includeţi datele în copia de siguranţă.
-overwrite -o Opţional. Suprascrieţi fişierul copie de siguranţă existent.
-generateartifactlist -gal Opţional. Generaţi un fişier de text care conţine o listă completă de artefacte exportate. Puteţi utiliza acest fişier de text pt. a administra importul artefactelor. De exemplu, puteţi rearanja ordinea artefactelor în listă pt. a controla ordinea în care acestea sunt importate. Puteţi omite importul anumitor artefacte prin eliminarea sau comentarea elementelor din listă.
-include-server-level -isl Opţional. Includeţi conexiunile definite la nivel global şi sursele de date.
-cube -c Opţional. Se exportă un singur cub. Această opţiune poate fi specificată alături de opţiunile doar pentru export: date, fişiere de anumite tipuri, partiţii sau filtre.
-exportdata -d Opţional. Se exportă doar date.
-filetype -ft

Opţional. Se exportă doar fişiere de tipul specificat. Fişierele acceptate includ OTL (structură), TXT (text), RUL (regulă), CSC (script de calcul), DTR (definiţie raport de detaliere) şi Excel (sunt exportate doar fişierele .xls. Fişierele .xlsx nu sunt exportate).

Exemple:

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

Opţional. Se exportă doar definiţiile partiţiei.

Operaţiile de import Lifecycle Management (LCM) (şi importarea utilitarului pentru migrare) nu sunt acceptate pentru migrarea partiţiilor ca elemente ale unei federaţii. Partiţiile ca elemente ale unei federaţii trebuie să fie recreate manual pe destinaţie.
-exportfilters -ef Opţional. Se exportă doar filtrele de securitate.
-restEncryPassword -encryPwd

Dacă aplicaţia este criptată, aceasta este parola care o protejează când are loc migrarea. Parola trebuie să aibă între 6 şi 15 caractere şi nu trebuie să conţină niciunul dintre aceste caractere speciale: ?=.,*!@#&()[{}]:;'/~$^+<>-

Atenţie: Dacă uitaţi această parolă, nu există niciun mod în care să o mai puteţi recupera, iar aplicaţia nu va putea fi importată.

Note

Această comandă, ca alte comenzi CLI, poate fi utilizată din afara maşinii Essbase, pe când utilitarul LCM trebuie rulat pe maşina Essbase.

Exemplu

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

Exemplu de script pt. Windows

Următorul script pentru Windows, lcmexportall.bat, exportă toate aplicaţiile în directorul local curent de unde a fost apelată interfaţa în linie de comandă.

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: Restaurarea fişierelor cuburilor

Comanda lcmimport din CLI pentru Essbase restabileşte artefactele de tip cub dintr-un fişier .zip Lifecycle Management (LCM). Pentru a rula această comandă, trebuie să fiţi utilizatorul avansat care a creat aplicaţia sau un administrator al serviciului.

Sintaxă

lcmImport [-verbose] -zipfilename filename [-overwrite] [-targetappName targetApplicationName][-include-server-level][-artifactlist artifactList][-restEncryPassword]
Opţiune Abreviere Descriere
-verbose -v Opţional. Afişaţi descrierile extinse
-zipfilename -z Numele fişierului comprimat, care conţine fişiere copii de siguranţă
-overwrite -o Opţional. Re-creaţi aplicaţia destinaţie.
-targetappName -ta Opţional. Numele aplicaţiei destinaţie, dacă doriţi ca acesta să fie diferit de numele sursei.
-artifactlist -al Opţional. Numele fişierului care conţine lista de artefacte de importat. Acest fişier poate fi generat din Icmexport.

Pentru a omite artefacte, comentaţi sau ştergeţi intrările din listă. De exemplu, pt. a omite importul înregistrărilor de audit, comentaţi acea linie, aşa cum se indică:

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

Pentru a controla ordinea importului, rearanjaţi intrările de import în fişierul de text.

Dacă se utilizează –suprascriere, operaţia de import şterge şi recreează întreaga aplicaţie, importând numai artefactele prezente în listă. Dacă nu se utilizează –suprascrierea, operaţia de import include artefactele specificate în listă, fără a avea vreun impact asupra altor artefacte prezente deja în aplicaţia ţintă.
-include-server-level -isl Opţional. Includeţi conexiunile definite la nivel global şi sursele de date.
-restEncryPassword -encryPwd

Dacă aplicaţia este criptată, aceasta este parola care o protejează când are loc migrarea. Parola trebuie să aibă între 6 şi 15 caractere şi nu trebuie să conţină niciunul dintre aceste caractere speciale: ?=.,*!@#&()[{}]:;'/~$^+<>-

Atenţie: Dacă uitaţi această parolă, nu există niciun mod în care să o mai puteţi recupera, iar aplicaţia nu va putea fi importată.

Note

  • Această comandă, ca alte comenzi CLI, poate fi utilizată din afara maşinii Essbase, pe când utilitarul LCM trebuie rulat în cadrul maşinii Essbase.

  • La finalizarea importului LCM, este posibil să fie nevoie să întreprindeţi şi alte acţiuni pentru a restabili conexiunile migrate în surse externe. Pentru acest lucru, deschideţi conexiunea şi introduceţi parola.

  • Când există partiţii între cuburile care sunt migrate, trebuie să importaţi sursa de date înainte de destinaţia de date. În caz contrar, este posibil ca definiţiile partiţiilor să nu fie restabilite.

    Operaţiile de import Lifecycle Management (LCM) (şi importarea utilitarului pentru migrare) nu sunt acceptate pentru migrarea partiţiilor ca elemente ale unei federaţii. Partiţiile ca elemente ale unei federaţii trebuie să fie recreate manual pe destinaţie.

  • Importul LCM nu migrează acreditările aliasului locaţiei. Trebuie să înlocuiţi acreditările aliasului locaţiei, prin re-crearea a aliasurilor locaţiei, utilizând MaxL sau prin editarea acreditărilor aliasului locaţiei în fişierul XML exportat prin Export LCM.

Exemplu

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

Listapp: Afişarea aplicaţiilor

Comanda listapp din CLI listează aplicaţiile la care aveţi acces în această instanţă a Essbase.

Sintaxă

listapp [-verbose] [-details]
Opţiune Abreviere Descriere
-verbose -v Opţional. Afişaţi descrierile extinse
-details -dtl Opţional. Afişează mai multe detalii în rezultat (tipul aplicaţiei şi starea curentă).

Exemplu

esscs listapp -v -dtl

Listdb: Afişarea cuburilor

Comanda listdb din CLI listează bazele de date la care aveţi acces dintr-o anumită aplicaţie Essbase.

Sintaxă

listdb [-verbose] -application applicationName [details]
Opţiune Abreviere Descriere
-verbose -v Opţional. Afişaţi descrierile extinse
-application -a Numele aplicaţiei
-details -dtl Opţional. Afişaţi detalii despre stare în rezultate.

Exemplu

esscs listdb -v -a Sample -dtl

Listfiles: Afişarea fişierelor

Comanda listfiles din CLI listează artefactele de tip cub care există într-o instanţă Essbase.

Artefactele cuburilor pot include fişiere de date, registre de lucru, fişiere de reguli, fişiere script de calcul sau alte artefacte. Artefactele cuburilor includ toate fişierele de care este nevoie pt. efectuarea acţiunilor asupra aplicaţiilor şi cuburilor.

Pentru a lista fişierele unui cub, aveţi nevoie cel puţin de permisiunea de acces la baza de date. Nu sunt necesare permisiuni speciale pentru a lista fişierele din directorul dvs. de utilizator.

Sintaxă

listfiles [-verbose] [-type filetype] [-application appname [-db cubename] | -catalogpath catalogPath]
Opţiune Abreviere Descriere
-verbose -v Opţional. Afişaţi descrierile extinse
-type -t Opţional. Extensia/Tipul de fişier de afişat, fără a include punctul.

Tipurile de fişiere acceptate sunt:

  • .csc (script-uri de calcul)
  • .rul (fişiere de reguli)
  • .txt (fişiere text)
  • .msh (script-uri MaxL)
  • .xls, .xlsx (registre de calcul Excel)
  • .xlsm (registre de calcul Excel activate pt. macrocomenzi)
  • .xml (fişiere XML)
  • .zip (fişiere .zip comprimate)
  • .csv (fişiere separate prin virgulă)
-application -a Opţional. Numele aplicaţiei. Dacă nu sunt introduse, sunt afişate fişierele din directorul home al utilizatorului dvs.
-db -d Opţional. Numele bazei de date (cubului)
-catalogpath -CP Opţional. Calea din catalog spre numele de fişier. Se poate utiliza în loc de -a [-d] pentru a specifica locaţia fişierelor în cadrul catalogului.

Exemple

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

De asemenea, puteţi administra fişiere în Cube Designer, în interfaţa web Essbase sau în API-ul REST.

Listfilters: Vizualizarea filtrelor de securitate

Comanda listfilters din CLI afişează o listă cu filtrele de securitate Essbase. Este necesară cel puţin permisiunea "Acces al bazei de date" în aplicaţie pt. a vedea filtrele pt. orice cuburi din aplicaţie.

Sintaxă

listfilters [-verbose] -application appname -db cubename
Opţiune Abreviere Descriere
-verbose -v Opţional. Afişaţi descrierile extinse
-application -a Numele aplicaţiei
-db -d Numele bazei de date (cubului)

Exemplu

esscs listfilters -v -a Sample -d Basic

Listlocks: Vizualizarea blocărilor

Comanda listlocks din CLI pentru Essbase afişează toate blocurile de date blocate sau obiectele corelate cu cubul. Pentru a rula această comandă, aveţi nevoie cel puţin de permisiuni de acces la baza de date din aplicaţie.

Sintaxă

listlocks [-verbose] -application appname -db cubename [-object]
Opţiune Abreviere Descriere
-verbose -v Opţional. Afişaţi descrierile extinse
-application -a Numele aplicaţiei
-db -d Numele bazei de date (cubului)
-object -obj Opţional. Afişaţi fişierele/artefactele blocate.

Exemplu

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

Listvariables: Afişarea variabilelor de înlocuire

Comanda listvariables din CLI pentru Essbase listează variabilele de substituţie definite în domeniul cubului, în cel al aplicaţiei sau la nivel global. Aveţi nevoie cel puţin de permisiunea "Acces bază de date" pt. a vedea variabilele pt. un cub, "Manager de aplicaţii" pt. a vedea variabilele pt. o aplicaţie şi "Administrator de servicii" pentru a vedea variabilele globale.

Sintaxă

listvariables [-verbose] [-application application [-db database]]
Opţiune Abreviere Descriere
-verbose -v Afişează descrieri extinse.
-application -a Opţional. Numele aplicaţiei.
-database -db Opţional. Numele bazei de date (cubului).

Exemple

La nivel de cub

esscs listvariables -a Sample -db Basic

La nivel de aplicaţie

esscs listvariables -a Sample

La nivel global

esscs listvariables

Setpassword: Stocarea acreditărilor CLI

Comanda setpassword din CLI pentru Essbase stochează o parolă asociată cu combinaţia dvs. client/utilizator. În sesiunile următoare, vă puteţi conecta fără să introduceţi o parolă.

Sintaxă

 setpassword [-verbose] -essbaseurl URL -user userName
Opţiune Abreviere Descriere
-verbose -v Opţional. Afişaţi descrierile extinse
-essbaseurl -url Adresa unei instanţe a Essbase
-user -u Numele dvs. de utilizator

Note

După migrarea la Versiunea 21.4 sau o versiune ulterioară, trebuie să resetaţi orice parole stocate care au fost salvate utilizând această comandă într-o versiune anterioară.

Exemplu

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

Start: Pornirea unei aplicaţii sau a unui cub

Comanda start din CLI porneşte o aplicaţie sau un cub Essbase, încărcându-l în memorie. Pentru a rula această comandă, aveţi nevoie cel puţin de permisiuni de acces la baza de date din aplicaţie.

Sintaxă

start [-verbose] -application appname [-db cubename]
Opţiune Abreviere Descriere
-verbose -v Opţional. Afişaţi descrierile extinse
-application -a Numele aplicaţiei
-db -d Opţional. Numele bazei de date (cubului)

Exemplu

esscs start -v -a Sample -d Basic

Stop: Oprirea unei aplicaţii sau a unui cub

Comanda stop din CLI opreşte o aplicaţie sau un cub Essbase. Pentru a rula această comandă, aveţi nevoie cel puţin de permisiuni de acces la baza de date din aplicaţie.

Sintaxă

stop [-verbose] -application appname [-db cubename]
Opţiune Abreviere Descriere
-verbose -v Opţional. Afişaţi descrierile extinse
-application -a Numele aplicaţiei
-db -d Opţional. Numele bazei de date (cubului)

Exemplu

esscs stop -v -a Sample -d Basic

Unsetpassword: Au fost eliminate acreditările CLI din BD

Comanda unsetpassword din CLI pentru Essbase elimină acreditările de conectare stocate şi care sunt asociate cu combinaţia dvs. de client/utilizator, inversând efectul comenzii setpassword.

Sintaxă

unsetpassword [-verbose] -essbaseurl URL -user userName
Opţiune Abreviere Descriere
-verbose -v Afişaţi descrierile extinse
-essbaseurl -url Adresa unei instanţe a Essbase
-user -u Utilizatorul a cărui parolă se de-setează

Exemplu

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

Upload: Adăugarea fişierelor de cuburi

Comanda upload din CLI încarcă artefactele de tip cub dintr-un director local într-o instanţă Essbase.

Pentru a efectua sarcini precum încărcări de date, generări de dimensiuni, calcule sau alte operaţii, ar putea fi necesar să încărcaţi fişiere de date, fişiere de reguli, fişiere script de calcul sau alte artefacte în directorul cubului. De asemenea, puteţi încărca artefacte în directorul dvs. de utilizator.

Pentru a încărca fişiere într-un cub, aveţi nevoie cel puţin de permisiunea "Manager bază de date". Nu sunt necesare permisiuni speciale pentru a încărca directorul dvs. de utilizator.

Notă:

Puteţi să activaţi scanarea antivirus în interfaţa web Essbase pentru ca fişierele să fie scanate pentru viruşi înainte de a fi încărcate pe server.

Sintaxă

upload [-verbose] -file filename [-application appname [-db cubename] | -catalogpath catalogPath] [-overwrite] [-nocompression][-compressionalgorithm]
Opţiune Abreviere Descriere
-verbose -v Opţional. Afişaţi descrierile extinse
-file -f Numele fişierului de încărcat

Notă:

Extensiile fişierelor trebuie să fie scrise cu litere mici. De exemplu, filename.txt.
-application -a Opţional. Numele aplicaţiei. Dacă nu este introdus, fişiere sunt încărcate în directorul dvs. de utilizator, sau în calea din catalog specificată în -CP.
-db -d Opţional. Numele bazei de date (cubului). Necesită -a.
-catalogpath -CP Opţional. Calea din catalog spre numele de fişier. Se poate utiliza în loc de -a [-d] pentru a specifica locaţia fişierului în cadrul catalogului.
-overwrite -o Opţional. Suprascrieţi fişierul existent
-nocompression -nc Opţional. Dezactivaţi comprimarea transferului de date
-compressionalgorithm -ca Opţional. Disponibilă dacă nu este utilizată opţiunea -nc. Defineşte algoritmul de comprimare de utilizat pt. transferul de date. Opţiuni posibile: gzip sau lz4.

  • gzip - Este prestabilit dacă este utilizată comprimarea. Oferă transfer de date mai mic, cu calcul mai lent.

  • lz4 - Oferă calcul mai rapid, cu transfer de date mai lent.

Exemple de utilizare:

-ca gzip
-ca lz4

Exemple

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

De asemenea, puteţi administra fişiere în Cube Designer, în interfaţa web Essbase sau în API-ul REST.

Version: Afişarea versiunii API-ului

Comanda version din CLI preia versiunea API-ului REST asociat cu această instanţă de Essbase.

Sintaxă

version

Exemplu

esscs version