Opis poleceń narzędzia CLI (Command-Line Interface)

Aby móc wydawać jakiekolwiek inne polecenia CLI w odniesieniu do Essbase, trzeba się zalogować. Jeśli jest wymagane połączenie zabezpieczone, adres URL musi się zaczynać protokołem https.

Identyfikację można przeprowadzić za pomocą narzędzia CLI w dowolny z następujących sposobów:

• Użyć polecenia setpassword, aby zapisać hasło powiązane z kombinacją klient/użytkownik. W kolejnych sesjach można będzie używać polecenia login, nie podając hasła.
• Użyć polecenia login z opcjami -user i -password (ostrzeżenie: hasło będzie wyświetlane w oknie powłoki tekstem jawnym).
• Użyć polecenia login tylko z opcją -user. Będzie wyświetlany monit do podania hasła, które będzie ukrywane.

Jeśli użytkownik jest użytkownikiem używającym mechanizmu jednokrotnego federowanego logowania (SSO) do usługi Oracle Identity Cloud Service, to logowanie przy użyciu MaxL lub CLI nie jest obsługiwane. Mechanizm jednokrotnego sfederowanego logowania (SSO) wymaga okna przeglądarki. Można utworzyć natywnego użytkownika usługi Identity Cloud Service i używać go do logowania się przy użyciu MaxL lub CLI.

Składnia (login)

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

Przykład 1 (login)

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

Przykład 2 (login)

W poniższym przykładzie logujący się użytkownik admin1@example.com jest administratorem usługi Identity Cloud Service, który podczas wdrażania stosu Essbase w Oracle Cloud Infrastructure został określony jako początkowy administrator Essbase. Ponieważ w tym przykładzie hasło nie jest wprowadzane, administrator zostanie następnie wezwany do podania hasła. Adresem URL jest essbase_url z wyników zlecenia uzyskanych z wdrożenia stosu.

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

Składnia (logout)

logout

Przykład (logout)

esscs logout

Aby można było uruchamiać skrypty obliczeń, trzeba je najpierw wysłać jako pliki .csc do katalogu kostki. Do wysyłania plików można używać narzędzia CLI. Zob. Upload: dodawanie plików do kostki.

Składnia

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

Przykład

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

Skrypty obliczeń można także uruchamiać, używając opcji "Oblicz" z narzędzia Cube Designer lub Smart View, obszaru "Zlecenia" z internetowego interfejsu Essbase lub z REST API albo polecenia execute calculation z MaxL.

Składnia

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

Przykład

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

Dane można także wyczyścić, używając opcji "Ładowanie danych" z narzędzia Cube Designer, obszaru "Zlecenia" z internetowego interfejsu Essbase lub z REST API albo polecenia alter database DBS-NAME reset z MaxL.

Opis

Administrator usługi musi użyć tego polecenia w celu utworzenia i zapisania połączenia lokalnego, aby można było użyć polecenia CLI dataload lub dimbuild z opcją strumieniowania. Trzeba również ustawić zmienną środowiskową EXTERNAL_CLASSPATH tak, aby wskazywała plik .jar sterownika bazy danych (zob. Strumieniowe konstruowanie wymiarów i ładowanie danych z odległej bazy danych).

Składnia

createLocalConnection [-verbose] -name streamConnection -connectionstring  connectionString -user userName [-driver jdbcDriver] [-password password]

jdbc:oracle:thin:@host:port/service_name

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

Mając łączność sieciową między zewnętrznym źródłem danych a Essbase, najbardziej efektywnym sposobem jest zdefiniowanie połączeń poziomu aplikacji lub połączeń globalnych i źródeł danych za pomocą internetowego interfejsu Essbase. Definicje te pomagają z łatwością ściągać dane z zewnętrznego źródła. Nie mając łączności sieciowej między Essbase a zewnętrznym źródłem danych, należy strumieniować ładowanie danych lub konstruowanie wymiarów danych, używając narzędzia CLI: najpierw tworząc połączenie lokalne, a następnie uruchamiając polecenie dataload lub dimbuild z opcją strumieniowania.

Uwagi

Po wykonaniu migracji do wydania 21.4 lub nowszego administrator usługi musi ponownie utworzyć wszystkie zapisane połączenia lokalne, które zostały utworzone w poprzednim wydaniu za pomocą tego polecenia.

Przykłady

To polecenie wymaga jednego z następujących zestawów:

• Plik danych i opcjonalny plik reguł.

• Plik reguł z nazwą użytkownika i hasłem.

• Opcja "stream" odwołująca się do zapisanego połączenia lokalnego

Źródłowa baza danych powinna być dostępna w obrębie sieci klienta, ponieważ nie wszystkie sterowniki baz danych współpracują z proxy Java.

Aby można było ładować dane, trzeba najpierw wysłać do katalogu kostki plik ładowania danych i plik reguł. Do wysyłania plików można używać narzędzia CLI. Zob. Upload: dodawanie plików do kostki.

Składnia

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]

Przykłady

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"

Dane można także załadować, używając opcji "Ładowanie danych" z narzędzia Cube Designer, obszaru "Zlecenia" z internetowego interfejsu Essbase lub REST API albo polecenia import data z MaxL.

Składnia

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

Przykłady

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

esscs deletefile -CF /shared/Data.txt

Można także zarządzać plikami, korzystając z narzędzia Cube Designer, internetowego interfejsu Essbase lub REST API.

Składnia

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

Przykłady

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

Kostki można także wdrażać, używając narzędzia Cube Designer lub opcji "Import" z obszaru Aplikacje z internetowego interfejsu Essbase.

Aby można było załadować wymiary, trzeba najpierw wysłać do Essbase plik konstruowania wymiarów i plik reguł. Do wysyłania plików można używać narzędzia CLI. Zob. Upload: dodawanie plików do kostki.

Składnia

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]

Przykłady

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

Wymiary można także załadować, używając opcji "Ładowanie danych" z narzędzia Cube Designer, obszaru "Zlecenia" z internetowego interfejsu Essbase lub REST API albo polecenia import dimensions z MaxL.

Można pobrać z kostki pliki tekstowe, pliki reguł lub pliki skryptów obliczeń, a następnie pracować z nimi lub wysłać je do innej kostki. Aby pobrać artefakty kostki, użytkownik musi mieć przynajmniej uprawnienie "Aktualizacja bazy danych".

Składnia

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

Przykłady

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

Można także zarządzać plikami, korzystając z narzędzia Cube Designer, internetowego interfejsu Essbase lub REST API.

Składnia

[command] -help | -h

Przykłady

esscs -help

esscs -h

esscs dataload -help

Składnia

lcmExport [-verbose] -application appname|-allApp -zipfilename filename [-localDirectory path][-threads threadscount][-skipdata][-overwrite][-generateartifactlist][-include-server-level][-cube][-exportdata][-filetype][-exportpartitions][-exportfilters][-restEncryPassword]

esscs lcmexport -a sample -z sampleXLSOnly.zip -v -ft excel

esscs lcmexport -a sample -z sampleTXTOnly.zip -v -ft txt

Uwagi

Polecenia tego, podobnie jak innych poleceń CLI, można używać spoza maszyny Essbase. Narzędzie LCM musi być jednak uruchamiane w maszynie Essbase.

Przykład

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

Przykład skryptu dla systemu Windows

Poniższy skrypt dla systemu Windows, mający nazwę lcmexportall.bat, eksportuje wszystkie aplikacje do bieżącego katalogu lokalnego, z którego zostało wywołane narzędzie 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

Składnia

lcmImport [-verbose] -zipfilename filename [-overwrite] [-targetappName targetApplicationName][-include-server-level][-artifactlist artifactList][-restEncryPassword]

# ------------IMPORT-----------------
import @Provisions
import @Databases/Basic
#import @Databases/Basic/Audit
import @Databases/Basic/Text_files
import @Databases/Basic/Xml_files
import @Databases/Basic/Calc_scripts
import @Databases/Basic/Open_XML_Excel_files
import @Databases/Basic/ScenarioManagement
import @Databases/Basic/Provisions
import @Databases/Basic/Rule_files

Uwagi

• Polecenia tego, podobnie jak innych poleceń CLI, można używać spoza maszyny Essbase. Narzędzie LCM musi być jednak uruchamiane w maszynie Essbase.

• Po ukończeniu importu LCM może po migracji okazać się konieczne wykonanie dodatkowej czynności w celu odtworzenia połączeń ze źródłami zewnętrznymi. Aby to zrobić, należy otworzyć połączenie i podać hasło.

• Jeśli istnieją partycje dla kostek objętych migracją, to przed zaimportowaniem celu danych trzeba zaimportować źródło danych. W przeciwnym razie definicje partycji mogą nie zostać odtworzone.

  Operacje importu LCM (Lifecycle Management) (i importu przy użyciu narzędzia Migration Utility) nie są obsługiwane przy migracji partycji federowanych. Partycje federowane trzeba ręcznie odtworzyć w miejscu docelowym.

• Import LCM nie powoduje migracji uwierzytelnień aliasów lokalizacji. Należy zamienić uwierzytelnienia aliasów lokalizacji, tworząc ponownie aliasy lokalizacji za pomocą MaxL lub edytując uwierzytelnienia aliasów lokalizacji w pliku XML wyeksportowanym za pomocą eksportu LCM.

Przykład

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

Składnia

listapp [-verbose] [-details]

Przykład

esscs listapp -v -dtl

Składnia

listdb [-verbose] -application applicationName [details]

Przykład

esscs listdb -v -a Sample -dtl

Do artefaktów kostki zaliczają się np. pliki danych, skoroszyty, pliki reguł, pliki skryptów obliczeń lub inne. Artefaktami kostki są m.in. dowolne pliki, które są niezbędne do wykonania czynności związanych z aplikacją lub kostką.

Aby można było wyświetlić wykaz plików dla kostki, jest wymagane przynajmniej uprawnienie "Dostęp do bazy danych" dla aplikacji. W przypadku wyszczególniania plików ze swojego katalogu, użytkownik nie musi mieć żadnych specjalnych uprawnień.

Składnia

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

Przykłady

esscs listfiles -t rul -a Sample -d Basic 

esscs listfiles -CP "/shared"

Można także zarządzać plikami, korzystając z narzędzia Cube Designer, internetowego interfejsu Essbase lub REST API.

Składnia

listfilters [-verbose] -application appname -db cubename 

Przykład

esscs listfilters -v -a Sample -d Basic 

Składnia

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

Przykład

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

Składnia

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

Przykłady

Poziom kostki

esscs listvariables -a Sample -db Basic

Poziom aplikacji

esscs listvariables -a Sample

Poziom globalny

esscs listvariables

Składnia

 setpassword [-verbose] -essbaseurl URL -user userName

Uwagi

Po wykonaniu migracji do wydania 21.4 lub nowszego należy zresetować wszystkie przechowywane hasła, które zostały zapisane za pomocą tego polecenia w poprzednim wydaniu.

Przykład

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

Składnia

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

Przykład

esscs start -v -a Sample -d Basic

Składnia

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

Przykład

esscs stop -v -a Sample -d Basic 

Składnia

unsetpassword [-verbose] -essbaseurl URL -user userName

Przykład

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

Aby można było wykonać niektóre zadania (takie jak ładowanie danych, konstruowanie wymiarów czy wykonywanie obliczeń ), niekiedy trzeba wysłać do katalogu kostki pliki danych, pliki reguł, pliki skryptów obliczeń lub inne artefakty. Artefakty można także wysyłać do swojego katalogu użytkownika.

Użytkownik, aby móc wysłać pliki do kostki, musi mieć przynajmniej uprawnienie "Menedżer bazy danych". W przypadku wysyłania plików do swojego katalogu, użytkownik nie musi mieć żadnych specjalnych uprawnień.

Składnia

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

-ca gzip

-ca lz4

Przykłady

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

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

Można także zarządzać plikami, korzystając z narzędzia Cube Designer, internetowego interfejsu Essbase lub REST API.

Składnia

version

Przykład

esscs version