CLI-kommandoreferens

Innan du kan utfärda andra CLI-kommandon i Essbase måste du logga in. Om det krävs en säker anslutning måste URL-adressen börja med https.

Du kan autentisera på följande sätt med kommandoradsgränssnitt:

• Använd setpassword en gång för att låta lösenordet lagras för klient-/användarkombinationen. I följande sessioner kan du använda inloggningskommandot utan att bli ombedd att ange ett lösenord.
• Använd alternativen -användare och -lösenord med inloggningskommandot (Varning! Lösenordet visas i skalfönstret som klartext).
• Använd endast alternativet -användare med inloggningskommandot. Du ombeds ange lösenordet, vilket är dolt.

Om du är en användare med samordnad enkel inloggning i Oracles molntjänst för identiteter stöds inte inloggning med MaxL eller CLI. För samordnad enkel inloggning krävs ett webbläsarfönster. Skapa en ursprunglig användare av molntjänsten för identiteter och använd den i stället om du vill logga in med MaxL eller CLI.

Syntax (inloggning)

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

Exempel 1 (inloggning)

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

Exempel 2 (inloggning)

I följande exempel är användaren som loggar in, admin1@example.com, en administratör i molntjänsten för identiteter, som angavs som den ursprungliga Essbase-administratören under Essbase-stackdistributionen i Oracles molninfrastruktur. Eftersom lösenordet inte anges i det här exemplet får administratören en uppmaning om att ange det i nästa steg. URL:en är essbase_url från de jobbutdata som blir resultatet av stacken distribution.

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

Syntax (utloggning)

logout

Exempel (utloggning)

esscs logout

Innan du kan köra beräkningsskript måste du ladda upp skripten, som .csc-filer, till kubkatalogen. Du kan använda CLI:n för att ladda upp filer. Se Upload: Lägg till kubfiler.

Syntax

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

Exempel

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

Du kan även köra beräkningsskript med alternativet Beräkna i Kubdesigner eller Smart View, Jobb i Webbgränssnittet för Essbase eller REST-API:t, eller execute calculation i MaxL.

Syntax

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

Exempel

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

Du kan också rensa data med alternativen Ladda data i Kubdesigner, Jobb i Webbgränssnittet för Essbase eller REST-API:t, eller alter database DBS-NAME reset i MaxL.

Beskrivning

En tjänsteadministratör måste använda det här kommandot till att skapa och spara den lokala anslutningen innan någon kan använda CLI-kommandot dataload eller dimbuild med strömningsalternativet. Du måste även ange en miljövariabel, EXTERNAL_CLASSPATH, som pekar på .jar-filen för databasdrivrutinen(se Bygga dimensioner och ladda data genom strömning från en fjärrdatabas).

Syntax

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

Om du har nätverksanslutning mellan en extern datakälla och Essbase är det effektivast att definiera anslutningar och datakällor på applikationsnivå eller global nivå i Webbgränssnittet för Essbase. Dessa definitioner hjälper dig att enkelt "dra" data från den externa källan. Om du inte har någon nätverksanslutning mellan Essbase och den externa datakällan kan du strömma dataladdningar eller dimensionsbyggen med hjälp av CLI, genom att först använda det här kommandot för att skapa en lokal anslutning och sedan utfärda kommandot dataload eller dimbuild med strömningsalternativet.

Anteckningar

Efter migreringen till version 21.4 eller senare måste tjänsteadministratören återskapa alla sparade lokala anslutningar som skapats med kommandot i en tidigare version.

Exempel

Detta kommando kräver någon av följande uppsättningar med alternativ:

• Datafil och valfri regelfil

• Regelfil med användarnamn och lösenord

• Alternativet stream som refererar till en sparad lokal anslutning

Källdatabasen ska vara åtkomlig inom klientnätverket, eftersom det inte är alla databasdrivrutiner som kan arbeta med Java-proxyservrar.

För att kunna ladda data måste du först ladda upp dataladdnings- och regelfilerna till kubkatalogen. Du kan använda CLI:n för att ladda upp filer. Se Upload: Lägg till kubfiler.

Syntax

dataload [-verbose] -application appname -db cubename -file filename [| -catalogfile catalogFile] [-rule rulesFile | -catalogrulefile catalogRulesFile] [-user username [-password password]]  [-stream] [-connection connectionName][-query queryString] [-rows n]]  [-abortOnError]

Exempel

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"

Du kan även ladda data med hjälp av Kubdesigner, Jobb i Essbase-webbgränssnittet eller REST-API eller importera data i MaxL.

Syntax

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

Exempel

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

esscs deletefile -CF /shared/Data.txt

Du kan även hantera filer i Kubdesigner, Essbase-webbgränssnittet eller REST-API:t.

Syntax

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

Exempel

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

Du kan även distribuera kuber med hjälp av Kubdesigner eller genom att använda alternativet Importera i sektionen Applikationer i Webbgränssnittet för Essbase.

Innan du kan ladda dimensioner måste du ladda upp dimensionsbygg- och regelfilerna till Essbase. Du kan använda CLI:n för att ladda upp filer. Se Upload: Lägg till kubfiler.

Syntax

dimbuild [-verbose] -application appname -db cubename -file fileName [| -catalogfile catalogFile] -rule rulesFile [| -catalogrulefile catalogRulesFile]] [-user userName [-password password]] [-stream] [-connection connectionName][-query queryString] [-rows n]] [-restructureOption restructureOption] [-forcedimbuild]

Exempel

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

Du kan även ladda dimensioner med Kubdesigner, Jobb i Essbase-webbgränssnittet eller REST-API eller importera dimensioner i MaxL.

Du kan behöva ladda ned textfiler, regelfiler eller beräkningsskriptfiler från en kub så att du kan arbeta med dem eller ladda upp dem till en annan kub. För att kunna ladda ned kubartefakter måste du ha minst behörigheten Databasuppdatering.

Syntax

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

Exempel

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

Du kan även hantera filer i Kubdesigner, Webbgränssnittet för Essbase eller REST-API:t.

Syntax

[command] -help | -h

Exempel

esscs -help

esscs -h

esscs dataload -help

Syntax

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

Anteckningar

Det här kommandot kan precis som andra CLI-kommandon användas utanför Essbase-datorn, medan LCM-verktyget måste köras på Essbase-datorn.

Exempel

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

Exempel på Windows-skript

Med följande Windows-skript, lcmexportall.bat, exporteras alla applikationer till den aktuella lokala katalog från vilken CLI anropades.

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

Syntax

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

Anteckningar

• Det här kommandot kan precis som andra CLI-kommandon användas utanför Essbase-datorn, medan LCM-verktyget måste köras på Essbase-datorn.

• När LCM-importen har slutförts kan du behöva vidta ytterligare åtgärder för att återställa migrerade anslutningar till externa källor. Du gör det genom att öppna anslutningen och ange lösenordet.

• När det finns partitioner mellan kuber som exporteras så måste du importera datakällan före datamålet. Annars är det inte säkert att partitionsdefinitioner återställs.

  Importer med livscykelhantering (och import med migreringsverktyg) stöds inte för migrering av samordnade partitioner. Samordnade partitioner måste återskapas manuellt i målet.

• Med LCM-import migreras inte inloggningsuppgifter för platsalias. Du måste ersätta inloggningsuppgifterna för platsalias genom att återskapa platsalias med MaxL eller genom att redigera inloggningsuppgifterna för platsalias i den XML-fil som exporterats med LCM-export.

Exempel

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

Syntax

listapp [-verbose] [-details]

Exempel

esscs listapp -v -dtl

Syntax

listdb [-verbose] -application applicationName [details]

Exempel

esscs listdb -v -a Sample -dtl

Kubartefakter kan inkludera datafiler, arbetsböcker, regelfiler, beräkningsskriptfiler eller andra artefakter. Kubartefakter inkluderar alla filer som behövs för att utföra åtgärder på applikationer och kuber.

Om du vill lista filer för en kub måste du ha minst behörigheten Databasåtkomst för applikationen. Inga specifika behörigheter krävs för att lista filer från din användarkatalog.

Syntax

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

Exempel

esscs listfiles -t rul -a Sample -d Basic 

esscs listfiles -CP "/shared"

Du kan även hantera filer i Kubdesigner, Essbase-webbgränssnittet eller REST-API:t.

Syntax

listfilters [-verbose] -application appname -db cubename 

Exempel

esscs listfilters -v -a Sample -d Basic 

Syntax

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

Exempel

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

Syntax

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

Exempel

Kubnivå

esscs listvariables -a Sample -db Basic

Applikationsnivå

esscs listvariables -a Sample

Global nivå

esscs listvariables

Syntax

 setpassword [-verbose] -essbaseurl URL -user userName

Anteckningar

Efter att ha migrerat till version 21.4 eller senare måste du återställa alla lagrade lösenord som har sparats med det här kommandot i en tidigare version.

Exempel

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

Syntax

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

Exempel

esscs start -v -a Sample -d Basic

Syntax

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

Exempel

esscs stop -v -a Sample -d Basic 

Syntax

unsetpassword [-verbose] -essbaseurl URL -user userName

Exempel

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

Om du vill utföra åtgärder som dataladdningar, dimensionsbyggen, beräkningar eller andra åtgärder, kan du behöva ladda upp datafiler, regelfiler, beräkningsskriptfiler eller andra artefakter till kubkatalogen. Du kan också ladda upp artefakterna till din användarkatalog.

Om du vill ladda upp filer till en kub behöver du minst behörigheten Databasansvarig. Inga specifika behörigheter krävs för att ladda upp till din användarkatalog.

Syntax

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

-ca gzip

-ca lz4

Exempel

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

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

Du kan även hantera filer i Kubdesigner, Webbgränssnittet för Essbase eller REST-API:t.

Syntax

version

Exempel

esscs version