Riferimento dei comandi dell'interfaccia della riga di comando

Per poter eseguire qualsiasi altro comando dell'interfaccia della riga di comando per Essbase, è necessario eseguire il login. Se è richiesta una connessione sicura, l'URL utilizzato dovrà iniziare con https.

L'autenticazione mediante l'interfaccia della riga di comando è possibile con le modalità riportate di seguito.

• Utilizzare una volta setpassword per fare in modo che la password per la propria combinazione client-utente venga memorizzata. Nelle sessioni successive sarà possibile utilizzare il comando login senza che venga richiesto di immettere la password.
• Utilizzare le opzioni -user e -password con il comando login (attenzione: la password viene visualizzata nella finestra della shell con il testo in chiaro).
• Utilizzare solo l'opzione -user con il comando login. Viene richiesto di immettere la password, che viene nascosta.

Per un utente SSO federato in Oracle Identity Cloud Service, il login mediante MaxL o CLI non è supportato. Il login SSO federato richiede una finestra del browser. Invece di eseguire il login mediante MaxL o CLI, creare e utilizzare un utente Identity Cloud Service nativo.

Sintassi (login)

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

Esempio 1 (login)

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

Esempio 2 (login)

Nell'esempio seguente, l'utente che esegue il login, admin1@example.com, è un amministratore di Identity Cloud Service che è stato impostato come amministratore Essbase iniziale durante la distribuzione dello stack Essbase nell'infrastruttura Oracle Cloud. Poiché in questo esempio la password non viene immessa, all'amministratore verrà richiesto di fornirla in un secondo momento. L'URL è l'indirizzo essbase_url ricavato dagli output del job derivanti dalla distribuzione dello stack.

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

Sintassi (logout)

logout

Esempio (logout)

esscs logout

Per poter eseguire gli script di calcolo, è necessario in primo luogo caricare gli script, sotto forma di file .csc, nella directory del cubo. Per caricare i file è possibile utilizzare l'interfaccia della riga di comando. Vedere Upload: aggiungere file al cubo.

Sintassi

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

Esempio

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

Inoltre, è possibile eseguire gli script di calcolo mediante l'opzione Calcola in Cube Designer o Smart View, i job nell'interfaccia Web di Essbase o nell'API REST oppure con execute calculation in MaxL.

Sintassi

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

Esempio

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

Inoltre, è possibile cancellare i dati mediante l'opzione Carica dati in Cube Designer, mediante Job nell'interfaccia Web di Essbase o nell'API REST oppure con alter database DBS-NAME reset in MaxL.

Descrizione

L'Amministratore servizi deve usare questo comando per creare e salvare la connessione locale prima che si possa usare il comando dataload o dimbuild dell'interfaccia della riga di comando con l'opzione di streaming. È inoltre necessario impostare la variabile di ambiente EXTERNAL_CLASSPATH in modo che punti al file .jar per il driver del database (vedere Generare le dimensioni e caricare i dati in modalità streaming da un database remoto).

Sintassi

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

Se si dispone di una connettività di rete tra un'origine esterna di dati ed Essbase, definire le connessioni a livello di applicazione o globali e le origini dati nell'interfaccia Web di Essbase è il metodo più efficiente. Queste definizioni consentono di "estrarre" facilmente i dati dall'origine esterna. Se non si dispone della connettività di rete tra Essbase e l'origine esterna dei dati, è consigliabile eseguire lo streaming dei caricamenti dati o delle generazioni di dimensioni utilizzando l'interfaccia CLI, prima creando una connessione locale e poi eseguendo il comando dataload o dimbuild con l'opzione di streaming.

Note

Dopo aver eseguito la migrazione alla release 21.4 o successiva, l'amministratore di servizi deve ricreare le connessioni locali salvate che sono state create utilizzando questo comando in una release precedente.

Esempi

Questo comando richiede uno dei set di opzioni seguenti:

• File di dati e file di regole facoltativo

• File di regole con nome utente e password

• Opzione stream che fa riferimento a una connessione locale salvata

Il database di origine deve essere accessibile all'interno della rete client, perché non tutti i driver del database possono funzionare con i proxy Java.

Per caricare i dati, è necessario in primo luogo caricare i file di caricamento dati e delle regole nella directory del cubo. Per caricare i file è possibile utilizzare l'interfaccia della riga di comando. Vedere Upload: aggiungere file al cubo.

Sintassi

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]

Esempi

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"

È possibile caricare i dati anche mediante Cube Designer, Job nell'interfaccia Web di Essbase, un'interfaccia API REST oppure importare i dati in MaxL.

Sintassi

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

Esempi

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

esscs deletefile -CF /shared/Data.txt

Inoltre, è possibile gestire i file in Cube Designer, nell'interfaccia Web di Essbase o nell'API REST.

Sintassi

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

Esempi

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

Inoltre, è possibile distribuire i cubi mediante Cube Designer o l'opzione Importa nella sezione Applicazioni dell'interfaccia Web di Essbase.

Prima di poter caricare le dimensioni, è necessario caricare i file di generazione delle dimensione e delle regole in Essbase. Per caricare i file è possibile utilizzare l'interfaccia della riga di comando. Vedere Upload: aggiungere file al cubo.

Sintassi

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]

Esempi

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

È possibile caricare le dimensioni anche mediante Cube Designer, Job nell'interfaccia Web di Essbase, un'interfaccia API REST oppure importare dimensioni in MaxL.

Potrebbe essere necessario scaricare file di testo, file di regole o file degli script di calcolo da un cubo per poterli utilizzare o caricare in un altro cubo. Per scaricare gli artifact dei cubi, è necessario disporre almeno dell'autorizzazione Aggiornamento database.

Sintassi

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

Esempi

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

Inoltre, è possibile gestire i file in Cube Designer, nell'interfaccia Web di Essbase o nell'API REST.

Sintassi

[command] -help | -h

Esempi

esscs -help

esscs -h

esscs dataload -help

Sintassi

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

Note

Questo comando, come gli altri comandi dell'interfaccia della riga di comando, può essere utilizzato al di fuori del computer Essbase, mentre la utility LCM deve essere eseguita nel computer Essbase.

Esempio

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

Esempio di script Windows

Lo script di Windows seguente, lcmexportall.bat, consente di esportare tutte le applicazioni nella directory locale corrente da cui è stata richiamata l'interfaccia della riga di comando.

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

Sintassi

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

Note

• Questo comando, come gli altri comandi dell'interfaccia della riga di comando, può essere utilizzato al di fuori del computer Essbase, mentre la utility LCM deve essere eseguita nel computer Essbase.

• Una volta completata l'importazione LCM, potrebbe essere necessario eseguire ulteriori azioni per ripristinare le connessioni di cui è stata eseguita la migrazione verso origini esterne. A tale scopo, aprire la connessione e immettere la password.

• Quando esistono partizioni tra i cubi in fase di migrazione, è necessario importare l'origine dati prima della destinazione dati. In caso contrario, le definizioni delle partizioni potrebbero non essere ripristinate.

  Le operazioni di importazione Lifecycle Management (LCM), nonché l'importazione della utility di migrazione, non sono supportate per la migrazione delle partizioni federate. Le partizioni federate devono essere ricreate manualmente nella destinazione.

• L'importazione LCM non esegue la migrazione delle credenziali degli alias di posizione. È necessario sostituire le credenziali degli alias di posizione ricreando gli alias di posizione mediante MaxL oppure modificando le credenziali degli alias di posizione nel codice XML esportato dal job di esportazione LCM.

Esempio

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

Sintassi

listapp [-verbose] [-details]

Esempio

esscs listapp -v -dtl

Sintassi

listdb [-verbose] -application applicationName [details]

Esempio

esscs listdb -v -a Sample -dtl

Gli artifact di cubo possono includere file di dati, cartelle di lavoro, file di regole, file di script di calcolo o altri artifact. Possono inoltre includere tutti i file necessari per eseguire azioni sulle applicazioni e sui cubi.

Per elencare i file per un cubo è necessario disporre almeno dell'autorizzazione Accesso a database per il cubo interessato. Per elencare i file dalla propria directory utente non sono necessarie autorizzazioni speciali.

Sintassi

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

Esempi

esscs listfiles -t rul -a Sample -d Basic 

esscs listfiles -CP "/shared"

Inoltre, è possibile gestire i file in Cube Designer, nell'interfaccia Web di Essbase o nell'API REST.

Sintassi

listfilters [-verbose] -application appname -db cubename 

Esempio

esscs listfilters -v -a Sample -d Basic 

Sintassi

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

Esempio

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

Sintassi

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

Esempi

Livello cubo

esscs listvariables -a Sample -db Basic

A livello di applicazione

esscs listvariables -a Sample

Livello globale

esscs listvariables

Sintassi

 setpassword [-verbose] -essbaseurl URL -user userName

Note

Dopo aver eseguito la migrazione alla release 21.4 o successiva, è necessario reimpostare tutte le password memorizzate che sono state salvate utilizzando questo comando in una release precedente.

Esempio

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

Sintassi

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

Esempio

esscs start -v -a Sample -d Basic

Sintassi

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

Esempio

esscs stop -v -a Sample -d Basic 

Sintassi

unsetpassword [-verbose] -essbaseurl URL -user userName

Esempio

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

Per eseguire task quali il caricamento dei dati, la generazione delle dimensioni, i calcoli o altre operazioni, potrebbe essere necessario caricare i file di dati, i file delle regole, i file degli script di calcolo o altri artifact nella directory del cubo. È inoltre possibile caricare gli artifact nella propria directory utente.

Per caricare i file in un cubo è necessario disporre almeno dell'autorizzazione Gestione database. Per eseguire il caricamento nella propria directory utente non sono necessarie autorizzazioni speciali.

Sintassi

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

-ca gzip

-ca lz4

Esempi

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

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

Inoltre, è possibile gestire i file in Cube Designer, nell'interfaccia Web di Essbase o nell'API REST.

Sintassi

version

Esempio

esscs version