CLI-kommandoreference

De Essbase-CLI-kommandoer, som du udsteder i esscs-shell, hjælper dig med at udføre rutineplatformoperationer, herunder: calc, dataload, dimbuild, lcmexport, lcmimport, upload og download af artefakter, start og stop af en applikation eller kube med mere.

Følgende kommandoer er tilgængelige i kommandolinjeinterface. Argumenter til kommander kan udstedes i en hvilken som helst rækkefølge.

Indtast esscs -h for at få vist hjælp til alle kommandoer. Indtast esscs -kommandoen -h for at få vist hjælp til en specifik kommando.

Du slår udførligt output for en kommando til, hvilket vil sige, at de udvidede oplysninger (hvis de findes) vises, ved at indtaste esscs kommando -v kommandoargumenter.

Login/logout: CLI-autentificering

CLI-kommandoen login for Essbase autentificerer dig for Essbase, så du kan bruge CLI'en.

Du skal logge på, før du kan udstede andre CLI-kommandoer til Essbase. Hvis der kræves en sikker forbindelse, skal URL'en begynde med https.

Du kan autentificere på følgende måder ved hjælp af CLI:

  • Brug setpassword én gang for at få gemt adgangskoden for din kombination af klient/bruger. I efterfølgende sessioner kan du bruge kommandoen login uden at blive bedt om at indtaste en adgangskode.
  • Brug valgene -user og -password sammen med kommandoen login (Advarsel: Adgangskoden vises i shell-vinduet som cleartext).
  • Brug kun valget -user sammen med kommandoen login. Du bliver bedt om at indtaste adgangskoden, som er skjult.

Hvis du er samlet SSO-bruger i tjenesten Oracle Identity Cloud, understøttes logon med MaxL eller CLI ikke. Samlet SSO-logon kræver et browservindue. Opret en oprindelig Identity Cloud Service-bruger, og brug den i stedet, når du logger på ved hjælp af MaxL eller CLI.

Syntaks (logon)

login [-verbose] -essbaseurl https://instance-name.example.com/essbase -user username [-password password]
Valg Forkortelse Beskrivelse
-verbose -v Viser udvidede beskrivelser
-essbaseurl -url Adressen på en instans af Essbase
-user -u Brugernavn
-password -p Valgfrit. Adgangskode for bruger. Du kan også angive adgangskoden ved hjælp af setpassword.

Hvis du udsteder logonkommandoen fra et script, og adgangskoden indeholder specialtegn, skal den omsluttes af dobbelte anførselstegn (for eksempel "aNb3^5%9$!").

Brug af tegnet $ (dollartegn) i Essbase-adgangskoden understøttes ikke for logons i et Linux-miljø.

Eksempel 1 (logon)

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

Eksempel 2 (logon)

I det følgende eksempel er brugeren, der logger på, admin1@example.com, en Identity Cloud Service-administrator, der blev angivet som den første Essbase-administrator under ibrugtagning af Essbase-stakken i Oracle Cloud Infrastructure. Da adgangskoden ikke indtastes i dette eksempel, bliver administratoren bedt om at angive den efterfølgende. URL'en er den essbase_url fra joboutput, som er resultatet af ibrugtagning af stakken.

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

Syntaks (logoff)

logout

Eksempel (logoff)

esscs logout

Calc: Kør et beregningsscript

CLI-kommandoen calc for Essbase udfører et beregningsscript på kuben. For at køre denne kommando skal du mindst have tilladelsen Databaseopdatering samt provisioneret adgang til beregningsscriptet.

Før du kan køre beregningsscripts, skal du uploade scripterne som .csc-filer til kubekataloget. Du kan bruge CLI til upload af filer. Se Upload: Tilføje kubefiler.

Syntaks

calc [-verbose] -application appname -db cubename -script scriptfilename
Valg Forkortelse Beskrivelse
-verbose -v Viser udvidede beskrivelser
-application -a Applikationsnavn
-db -d Databasenavn (kube)
-script -s Navn på beregningsscript. Skal have filtypenavnet .csc. Du behøver ikke at angive en fuld sti. Filer antages at være placeret i det relevante kubekatalog.

Eksempel

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

Du kan også køre beregningsscripts ved hjælp af valget Beregn i Kubedesigner eller Smart View, Job i Essbase-webinterfacet eller REST API eller execute calculation i MaxL.

Clear: Fjerne data fra en kube

CLI-kommandoen clear for Essbase rydder data fra en kube. For at bruge denne kommando skal du mindst have tilladelsen Databaseopdatering.

Syntaks

clear [-verbose] -application appname -db cubename [-option clearOption[-regionspec regionSpec]]
Valg Forkortelse Beskrivelse
-verbose -v Valgfrit. Viser udvidede beskrivelser
-application -a Applikationsnavn
-db -d Databasenavn (kube)
-option -O Valgfrit. Nøgleord, der angiver, hvad der skal ryddes. Standardvalg, som, hvis udeladt, er ALL_DATA.

Valgmulighederne for bloklagerkuber er:

  • ALL_DATA - Alle data, sammenkædede objekter og outlinen ryddes

  • UPPER_LEVEL - Blokke på øverste niveau ryddes

  • NON_INPUT - Blokke uden input ryddes

Valgmulighederne for kuber med aggregeret lagering er:

  • ALL_DATA - Alle data, sammenkædede objekter og outlinen ryddes

  • ALL_AGGREGATIONS

    - Alle aggregerede data ryddes

  • PARTIAL_DATA

    - Kun det angivne dataområde ryddes. Bruges sammen med -regionspec
-regionspec -rs MDX-udtryk, der angiver det område, der skal ryddes

Eksempel

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

Du kan også rydde data ved hjælp af valget Indlæs data i Kubedesigner, Job i Essbase-webinterfacet eller REST API eller alter database DBS-NAME reset i MaxL.

Createlocalconnection: Gem en JDBC-forbindelse

CLI-kommandoen createlocalconnection for Essbase opretter en JDBC-forbindelse og gemmer den lokalt. Hvis du vil bruge denne kommando, skal du have rollen serviceadministrator eller superbruger.

Beskrivelse

En tjenesteadministrator skal bruge denne kommando til at oprette og gemme den lokale forbindelse, før nogen kan bruge CLI-kommandoerne dataload eller dimbuild med streamingvalget. Du skal også indstille miljøvariablen EXTERNAL_CLASSPATH til at pege på .jar-filen til din databasedriver (se Opbygge dimensioner og indlæse data ved hjælp af streaming fra en ekstern database).

Syntaks

createLocalConnection [-verbose] -name streamConnection -connectionstring  connectionString -user userName [-driver jdbcDriver] [-password password]
Valg Forkortelse Beskrivelse
-verbose -v Viser udvidede beskrivelser
-name -N Forbindelsesnavn
-connectionstring -cs JDBC-forbindelsesstreng. Format kan være med servicenavn som følger: 
jdbc:oracle:thin:@host:port/service_name

eller med SID som følger:

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

Syntaksformatet ovenfor gælder for Oracle Database. Se afsnittet Eksempler for at få oplysninger om mindre forskelle i forbindelsesstrengens syntaks, når du samarbejder med andre udbydere.
-user -u Brugernavn
-driver -D JDBC-driver. Hvis en Oracle-database ikke er angivet, anses den for at være standarden, som oracle.jdbc.driver.OracleDriver
-password -p Adgangskode (valgfri)

Hvis du har netværksforbindelse mellem en ekstern datakilde og Essbase, er det mest effektivt at definere forbindelser på applikationsniveau eller globalt og datakilder i Essbase-webinterfacet. Disse definitioner hjælper dig med nemt at udføre "pull" af data fra den eksterne kilde. Hvis du ikke har netværksforbindelse mellem Essbase og den eksterne datakilde, kan du streame dataindlæsninger eller dimensionsbygninger ved hjælp af CLI ved først at bruge denne kommando til at oprette en lokal forbindelse og derefter udstede kommandoen dataload eller dimbuild med valget stream.

Bemærkninger

Efter migrering til release 21.4 eller nyere skal serviceadministratoren genoprette eventuelle gemte lokale forbindelser, der er oprettet ved hjælp af denne kommando i en tidligere release.

Eksempler

Hvis valget -driver og parameteren jdbcDriver ikke angives, antages Oracle-databasen at være standarddatabasen.

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

Hvis valget -driver og parameteren jdbcDriver ikke angives, antages Oracle-databasen at være standarddatabasen.

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

Hvis valget -driver og parameteren jdbcDriver ikke angives, antages Oracle-databasen at være standarddatabasen.

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

Hvis valget -driver og parameteren jdbcDriver ikke angives, antages Oracle-databasen at være standarddatabasen.

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

Hvis valget -driver og parameteren jdbcDriver ikke angives, antages Oracle-databasen at være standarddatabasen.

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

Hvis valget -driver og parameteren jdbcDriver ikke angives, antages Oracle-databasen at være standarddatabasen.

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

Dataload: Indlæs data i en kube

CLI-kommandoen dataload for Essbase indlæser data i en kube. For at bruge denne kommando skal du mindst have tilladelsen Databaseopdatering.

Denne kommando kræver et af følgende sæt af parametre:

  • Datafil og valgfri regelfil

  • Regelfil med brugernavn og adgangskode

  • Valgmuligheden Stream henviser til en gemt, lokal forbindelse

Kildedatabasen skal være tilgængelig i klientnetværket, fordi ikke alle databasedrivere kan fungere med Java-proxyer.

Hvis du vil indlæse data, skal du først uploade dataindlæsnings- og regelfilerne til kubekataloget. Du kan bruge CLI til upload af filer. Se Upload: Tilføje kubefiler.

Syntaks

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]
Valg Forkortelse Beskrivelse
-verbose -v Viser udvidede beskrivelser
-application -a Applikationsnavn
-db -d Databasenavn (kube)
-file -f Navn på dataindlæsningsfil. Du behøver ikke at angive en fuld sti. Filer antages at være placeret i det relevante databasekatalog. Du kan bruge -catalogfile i stedet for denne parameter.
-rule -r Valgfrit. Navn på regelfil. Du behøver ikke at angive en fuld sti. Filer antages at være placeret i det relevante databasekatalog. Du kan bruge -catalogrulefile i stedet for denne parameter.
-catalogfile -CF Navnet på dataindlæsningsfilen fra filkataloget. Du kan bruge denne parameter i stedet for -file.
-catalogrulefile -CRF Navnet på regelfilen fra filkataloget. Du kan bruge denne parameter i stedet for -rule.
-user -u Valgfrit. Brugernavn. Kræver adgangskode, hvis den bruges.

Hvis du bruger en gemt forbindelse og datakilde, kræves der ikke brugernavn og adgangskode. Hvis du ikke bruger en gemt forbindelse, og regelfilen opretter forbindelse til et RDBMS, skal du angive brugernavnet og -adgangskoden for at oprette forbindelse til RDBMS.
-password -p Valgfrit. Adgangskode for bruger. Hvis den udelades, bliver brugeren spurgt om adgangskoden.
-stream -S Valgfrit. Brug dataindlæsning ved hjælp af streaming. Kræver valget -conn, hvis det bruges.
-connection -conn Påkrævet, hvis streamingvalget bruges. Navn på gemt forbindelse, der blev oprettet ved hjælp af CLI-kommandoen createlocalconnection.
-query -q Valgfrit. Databaseforespørgsel, der skal afsendes sammen med indlæsningen af streamingdata.
-rows -rows Valgfrit. Antal rækker, der skal streames samtidigt. Standard er 100.
-abortOnError -abort Afbryd dataindlæsning, hvis der registreres fejl

Eksempler

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 også indlæse data ved hjælp af Kubedesigner, Jobs i Essbase-webinterfacet eller REST-API eller Importer data i MaxL.

Deletefile: Fjern kubefiler

CLI-kommandoen deletefile for Essbase fjerner kubeartefakter fra applikationen, databasen eller brugerens startmappe. For at kunne slette filer i en kube skal du mindst have tilladelsen Databasestyring til kuben. Der kræves ingen særlige tilladelser for at slette filer i dit brugerkatalog.

Syntaks

deletefile [-verbose] -file fileName [-application application [-db  database] [| -catalogfile catalogFile]]
Valg Forkortelse Beskrivelse
-verbose -v Viser udvidede beskrivelser
-file -f Navn på den fil, der skal slettes
-application -a Valgfrit. Applikationsnavn. Hvis det ikke er angivet, antages det, at filerne findes i dit startsidekatalog.
-database -db Valgfrit. Databasenavn (kube)
-catalogfile -CF Filsti og -navn fra filkataloget. Du kan bruge denne parameter i stedet for -file.

Eksempler

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

Du kan også håndtere filer i Kubedesigner, Essbase-webinterfacet eller REST-API'en.

Deploy: Opret en kube fra en projektmappe

CLI-kommandoen deploy for Essbase opretter en kube ud fra en Excel-applikationsprojektmappe. For at køre denne kommando skal du mindst have rollen Superbruger.

Syntaks

deploy [-verbose] -file fileName [-application application [-database database] | -catalogfile catalogFile] [-restructureoption restructureOption] [-loaddata] [-recreateapplication] [-createfiles] [-executescript]
Valg Forkortelse Beskrivelse
-verbose -v Viser udvidede beskrivelser
-file -f Navnet på filen med applikationsprojektmappen
-application -a Valgfrit. Applikationsnavn. Hvis applikationsnavnet ikke angives, tages det fra projektmappen.
-database -db Valgfrit. Databasenavn (kube). Hvis databasenavnet ikke angives, tages det fra projektmappen.
-catalogfile -CF Applikationsprojektmappe fra filkataloget. Du kan bruge denne parameter i stedet for -file.
-loaddata -l Valgfrit. Indlæs data, hvis applikationsprojektmappen ikke indeholder et dataprojektark. Ellers importeres kun metadata i kuben.
-restructureoption -R Valgfrit. Nøgleord, der angiver det ønskede omstruktureringsvalg.

Valgmulighederne for bloklagerkuber er:

  • ALL_DATA — Bevar alle data

  • NO_DATA — Bevar ingen data

  • LEAFLEVEL_DATA — Bevar data på niveau 0 (bladniveau)

  • INPUT_DATA — Bevar inputdata

Valgmulighederne for kuber med aggregeret lagering er:

  • ALL_DATA — Bevar alle data

  • NO_DATA — Bevar ingen data
-recreateapplication -ra Valgfrit. Genopret applikationen, hvis den allerede findes
-createfiles -cf Valgfrit. Opret kubeartefakter i filkataloget i Essbase.
-executescript -e Valgfrit. Udfør beregningsscripts. Gælder kun, hvis applikationsprojektmappen indeholder et beregningsprojektark med Execute Calc angivet til Ja i definitionerne.

Eksempler

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 også implementere kuber ved hjælp af Kubedesigner eller ved hjælp af valget Importer i sektionen Applikationer i Essbase-webinterfacet.

Dimbuild: Indlæs dimensioner i en kube

CLI-kommandoen dimbuild for Essbase indlæser dimensioner i en kube. For at køre denne kommando skal du mindst have tilladelsen Databaseadgang til kuben.

Før du kan indlæse dimensioner, skal du uploade dimensionsopbygningen og regelfilerne til Essbase. Du kan bruge CLI til upload af filer. Se Upload: Tilføje kubefiler.

Syntaks

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]
Valg Forkortelse Beskrivelse
-verbose -v Viser udvidede beskrivelser
-application -a Applikationsnavn
-db -d Databasenavn (kube)
-file -f Navn på fil med dimensionsopbygning. Du behøver ikke at angive en fuld sti. Filer antages at være placeret i det relevante applikations- eller databasekatalog. Du kan bruge -catalogfile i stedet for denne parameter.
-rule -r Navn på regelfil. Du behøver ikke at angive en fuld sti. Filer antages at være placeret i det relevante applikations- eller databasekatalog. Du kan bruge -catalogrulefile i stedet for denne parameter.
-catalogfile -CF Navnet på dimensionsopbygningsfilen fra filkataloget. Du kan bruge denne parameter i stedet for -file.
-catalogrulefile -CRF Navnet på regelfilen fra filkataloget. Du kan bruge denne parameter i stedet for -rule.
-user -u Valgfrit. Brugernavn. Kræver adgangskode, hvis den bruges.

Hvis du bruger en gemt forbindelse og datakilde, kræves der ikke brugernavn og adgangskode. Hvis du ikke bruger en gemt forbindelse, og regelfilen opretter forbindelse til et RDBMS, skal du angive brugernavnet og -adgangskoden for at oprette forbindelse til RDBMS.
-password -p Valgfrit. Adgangskode for bruger. Hvis den udelades, bliver brugeren spurgt om adgangskoden.
-stream -S Valgfrit. Bruger dimensionsopbygning via streaming. Kræver valget -conn, hvis det bruges.
-connection -conn Påkrævet, hvis streamingvalget bruges. Navn på gemt forbindelse, der blev oprettet ved hjælp af CLI-kommandoen createlocalconnection.
-query -q Valgfrit. Databaseforespørgsel, der skal afsendes sammen med opbygningen af streamingdimensionen.
-rows -rows Valgfrit. Antal rækker, der skal streames samtidigt. Standard er 100.
-restructureOption -R

Styrer dine bevaringsvalg for omstrukturering af outlinen.

De mulige valg for bloklagring er:

  • ALL_DATA: Bevarer alle data under indlæsning af dimensioner.
  • NO_DATA: Bevarer ikke data.
  • LEAFLEVEL_DATA: Bevarer kun dataværdier på det laveste niveau. Hvis alle de data, der kræves til beregning, findes i medlemmer på det laveste niveau, skal du angive dette valg. Alle blokke på det øverste niveau slettes, før kuben omstruktureres. Når kuben genberegnes, genoprettes blokkene på øverste niveau.
  • INPUT_DATA: Bevar kun inputdata.

De mulige valg for aggregeret lagring er:

  • ALL_DATA: Bevarer alle data under indlæsning af dimensioner.
  • NO_DATA: Bevarer ikke data.
-forcedimbuild -F Fortsæt med dimensionsopbygningen, selvom andre brugeraktiviteter er i gang. Dette annullerer aktive brugersessioner.

Eksempler

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 også indlæse dimensioner ved hjælp af Kubedesigner, Jobs i Essbase-webinterfacet eller REST-API eller Importer dimensioner i MaxL.

Download: Hente kubefiler

CLI-kommandoen download for Essbase downloader kubeartefakter fra en instans af Essbase til et lokalt katalog.

Du skal måske downloade tekstfiler, regelfiler eller beregningsscriptfiler fra en kube, så du kan arbejde med dem eller uploade dem til en anden kube. For at downloade kubeartefakter skal du mindst have tilladelsen Databaseopdatering.

Syntaks

download [-verbose] -file filename[ | -catalogfile catalogFile] [-application appname [-db cubename]] [-localdirectory path] [-overwrite] [-nocompression]
Valg Forkortelse Beskrivelse
-verbose -v Viser udvidede beskrivelser
-file -f Navn på den fil, der skal downloades
-application -a Valgfrit. Applikationsnavn. Hvis det ikke er angivet, downloades artefakter fra dit startsidekatalog.
-db -d Valgfrit. Databasenavn (kube)
-catalogfile -CF Fil i filkataloget. Du kan bruge denne parameter i stedet for -file.
-localdirectory -ld Valgfrit. En sti til lokalt katalog
-overwrite -o Valgfrit. Overskriver den eksisterende fil
-nocompression -nc Valgfrit. Deaktiver komprimering af dataoverførsel

Eksempler

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 også håndtere filer i Kubedesigner, Essbase-webinterfacet eller REST-API'en.

Help: Vise kommandosyntaks

CLI-kommandoen help for Essbase viser hjælp på kommandoniveau i konsollen eller terminalen.

Syntaks

[command] -help | -h

Eksempler

esscs -help
esscs -h
esscs dataload -help

LcmExport: Sikkerhedskopiere kubefiler

CLI-kommandoen lcmexport for Essbase sikkerhedskopierer applikationer og kubeartefakter til en LCM-.zip-fil, som den downloader til din lokale maskine. For at køre denne kommando skal du mindst have tilladelsen Applikationsstyring til applikationen.

Syntaks

lcmExport [-verbose] -application appname|-allApp -zipfilename filename [-localDirectory path][-threads threadscount][-skipdata][-overwrite][-generateartifactlist][-include-server-level][-cube][-exportdata][-filetype][-exportpartitions][-exportfilters][-restEncryPassword]
Valg Forkortelse Beskrivelse
-verbose -v Valgfrit. Viser udvidede beskrivelser.
-application -a Navn på den applikation, der skal sikkerhedskopieres.
-allApp -aa Valgfri (og der skelnes mellem store og små bogstaver). Hvis det bruges i stedet for -application, eksporteres alle applikationer til én zip-fil. lcmimport kan både bruges til zip-filer med én applikation og zip-filer med flere applikationer.
-zipfilename -z Valgfrit. Navn på den komprimerede fil, der skal indeholde sikkerhedskopier.
-localdirectory -ld Valgfrit. En sti til lokalt katalog. Hvis det ikke er angivet, gemmes zip-filen i <Applikationskatalog>/katalog/brugere/<brugernavn> på Essbase-serveren.
-threads -T Valgfrit. Antal tråde, der skal oprettes, hvis der bruges paralleleksport. Minimum: 10
-skipdata -skip Valgfrit. Inkluderer ikke data i sikkerhedskopien.
-overwrite -o Valgfrit. Overskriver eksisterende fil med sikkerhedskopi.
-generateartifactlist -gal Valgfrit. Genererer en tekstfil, der indeholder en komplet liste over de eksporterede artefakter. Du kan bruge denne tekstfil til at håndtere importen af artefakter. Du kan for eksempel omarrangere rækkefølgen af artefakter på listen for at styre den rækkefølge, som de importeres i. Du kan springe nogle artefakter over ved at fjerne eller udkommentere punkterne på listen.
-include-server-level -isl Valgfrit. Inkluderer globalt definerede forbindelser og datakilder.
-cube -c Valgfrit. Eksporter en enkelt kube. Denne valgmulighed kan kun angives sammen med valgmulighederne til eksport: data, filer af visse typer, partitioner eller filtre.
-exportdata -d Valgfrit. Eksporter kun data.
-filetype -ft

Valgfrit. Eksporter kun filer af den angivne type. De understøttede filtyper omfatter OTL (outline), TXT (tekst), RUL (regel), CSC (beregningsscript), DTR (definition af gennemboringsrapport) og Excel (kun .xls-filer eksporteres. Ingen .xlsx-filer eksporteres).

Eksempler:

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

Valgfrit. Eksporter kun partitionsdefinitioner.

LCM-importoperationer (Lifecycle Management) (og import af migreringshjælpeprogram) understøttes ikke for migrering af samlede partitioner. Samlede partitioner skal oprettes igen manuelt på målet.
-exportfilters -ef Valgfrit. Eksporter kun sikkerhedsfiltre.
-restEncryPassword -encryPwd

Hvis applikationen er krypteret, er det en adgangskode til at beskytte den krypterede applikation under migrering. Adgangskoden skal være på mellem 6 og 15 tegn og må ikke indeholde nogen af følgende specialtegn: ?=.,*!@#&()[{}]:;'/~$^+<>-

Advarsel: Hvis denne adgangskode bliver glemt, er det ikke muligt at hente den igen, og applikationen kan ikke importeres.

Bemærkninger

Denne kommando kan som andre CLI-kommandoer bruges uden for Essbase-maskinen, mens hjælpeprogrammet LCM skal køres på Essbase-maskinen.

Eksempel

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

Eksempel på Windows-script

Følgende Windows-script, lcmexportall.bat, eksporterer alle applikationer til det aktuelle lokale katalog, som CLI er kaldt fra.

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: Gendanne kubefiler

CLI-kommandoen lcmimport for Essbase gendanner kubeartefakter fra en LCM-.zip-fil (Lifecycle Management). For at køre denne kommando skal du enten være den superbruger, der har oprettet applikationen, eller tjenesteadministrator.

Syntaks

lcmImport [-verbose] -zipfilename filename [-overwrite] [-targetappName targetApplicationName][-include-server-level][-artifactlist artifactList][-restEncryPassword]
Valg Forkortelse Beskrivelse
-verbose -v Valgfrit. Viser udvidede beskrivelser
-zipfilename -z Navn på den komprimerede fil, der indeholder sikkerhedskopier
-overwrite -o Valgfrit. Genopretter målapplikationen.
-targetappName -ta Valgfrit. Navn på målapplikationen, hvis det skal være anderledes end kildenavnet.
-artifactlist -al Valgfrit. Navnet på den fil, som indeholder listen over artefakter til import. Denne fil kan genereres fra lcmexport.

Du kan springe artefakter over ved at udkommentere eller slette poster fra listen. Hvis du for eksempel vil springe revisions-records over, skal du udkommentere den pågældende linje som vist:

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

Du kan styre importrækkefølgen ved at omarrangere import-posterne i tekstfilen.

Hvis –overwrite bruges, sletter importoperationen hele applikationen og opretter den igen, idet den kun importerer de artefakter, der findes på listen. Hvis –overwrite ikke bruges, inkluderer importoperationen de artefakter, der er angivet på listen, uden at andre artefakter, der allerede findes i målapplikationen, påvirkes.
-include-server-level -isl Valgfrit. Inkluderer globalt definerede forbindelser og datakilder.
-restEncryPassword -encryPwd

Hvis applikationen er krypteret, er det en adgangskode til at beskytte den krypterede applikation under migrering. Adgangskoden skal være på mellem 6 og 15 tegn og må ikke indeholde nogen af følgende specialtegn: ?=.,*!@#&()[{}]:;'/~$^+<>-

Advarsel: Hvis denne adgangskode bliver glemt, er det ikke muligt at hente den igen, og applikationen kan ikke importeres.

Bemærkninger

  • Denne kommando kan som andre CLI-kommandoer bruges uden for Essbase-maskinen, mens hjælpeprogrammet LCM skal køres på Essbase-maskinen.

  • Når LCM-importen er fuldført, skal du måske foretage yderligere handlinger for at gendanne migrerede forbindelser til eksterne kilder. Du gør dette ved at åbne forbindelsen og indtaste adgangskoden.

  • Når der er partitioner mellem kuber, som migreres, skal du importere datakilden før datamålet. I modsat fald gendannes partitionsdefinitioner muligvis ikke.

    LCM-importoperationer (Lifecycle Management) (og import af migreringshjælpeprogram) understøttes ikke for migrering af samlede partitioner. Samlede partitioner skal oprettes igen manuelt på målet.

  • LCM-import migrerer ikke legitimationsoplysninger til lokationsalias. Du skal erstatte dine legitimationsoplysninger til lokationsalias ved enten at genoprette lokationsaliasser ved hjælp af MaxL eller ved at redigere legitimationsoplysninger til lokationsalias i den XML, der er eksporteret af LCM-eksport.

Eksempel

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

Listapp: Vise applikationer

CLI-kommandoen listapp viser applikationer, som du har adgang til i denne instans af Essbase.

Syntaks

listapp [-verbose] [-details]
Valg Forkortelse Beskrivelse
-verbose -v Valgfrit. Viser udvidede beskrivelser
-details -dtl Valgfrit. Viser flere detaljer i outputtet (applikationstype og aktuel status).

Eksempel

esscs listapp -v -dtl

Listdb: Vise kuber

CLI-kommandoen listdb viser databaser, som du har adgang til i en angivet Essbase-applikation.

Syntaks

listdb [-verbose] -application applicationName [details]
Valg Forkortelse Beskrivelse
-verbose -v Valgfrit. Viser udvidede beskrivelser
-application -a Applikationsnavn
-details -dtl Valgfrit. Viser statusdetaljer i outputtet.

Eksempel

esscs listdb -v -a Sample -dtl

Listfiles: Vise filer

CLI-kommandoen listfiles viser kubeartefakter, der findes i en instans af Essbase.

Kubeartefakter kan omfatte datafiler, projektmapper, regelfiler, beregningsscriptfiler og andre artefakter. Kubeartefakter omfatter alle filer, der er nødvendige, for at du kan udføre handlinger på applikationer og kuber.

For at se en liste over filer til en kube skal du mindst have tilladelsen Databaseadgang til applikationen. Der kræves ingen særlige tilladelser for at se en liste over filer fra dit brugerkatalog.

Syntaks

listfiles [-verbose] [-type filetype] [-application appname [-db cubename] | -catalogpath catalogPath]
Valg Forkortelse Beskrivelse
-verbose -v Valgfrit. Viser udvidede beskrivelser
-type -t Valgfrit. Filtypenavn/filtype, der skal vises. Punktum er ikke inkluderet.

Understøttede filtyper er:

  • .csc (beregningsscripts)
  • .rul (regelfiler)
  • .txt (tekstfiler)
  • .msh (MaxL-scripts)
  • .xls, .xlsx (Excel-projektmapper)
  • .xlsm (Excel-projektmapper med aktiverede makroer)
  • .xml (XML-filer)
  • .zip (komprimerede zip-filer)
  • .csv (kommaseparerede filer)
-application -a Valgfrit. Applikationsnavn. Hvis det ikke er angivet, vises filer fra dit brugerstartsidekatalog.
-db -d Valgfrit. Databasenavn (kube)
-catalogpath -CP Valgfrit. Katalogsti til filnavnet. Kan bruges i stedet for -a [-d] til angivelse af filens eller filernes kataloglokation.

Eksempler

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

Du kan også håndtere filer i Kubedesigner, Essbase-webinterfacet eller REST-API'en.

Listfilters: Vis sikkerhedsfiltre

CLI-kommandoen listfilters viser en liste over Essbase-sikkerhedsfiltre. Du skal mindst have tilladelsen Databasestyring til applikationen for at se filtre for kuber i applikationen.

Syntaks

listfilters [-verbose] -application appname -db cubename
Valg Forkortelse Beskrivelse
-verbose -v Valgfrit. Viser udvidede beskrivelser
-application -a Applikationsnavn
-db -d Databasenavn (kube)

Eksempel

esscs listfilters -v -a Sample -d Basic

Listlocks: Vise låse

CLI-kommandoen listlocks for Essbase viser eventuelle låste datablokke eller kuberelaterede objekter. For at køre denne kommando skal du mindst have tilladelsen Databaseadgang til applikationen.

Syntaks

listlocks [-verbose] -application appname -db cubename [-object]
Valg Forkortelse Beskrivelse
-verbose -v Valgfrit. Viser udvidede beskrivelser
-application -a Applikationsnavn
-db -d Databasenavn (kube)
-object -obj Valgfrit. Viser låste filer/artefakter.

Eksempel

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

Listvariables: Vis erstatningsvariabler

CLI-kommandoen listvariables for Essbase viser erstatningsvariabler, der er defineret i kuben, applikationen eller det globale omfang. Du skal mindst have tilladelsen Databaseadgang for at se variabler for en kube, rollen Applikationsstyring for at se variabler for en applikation og rollen Tjenesteadministrator for at se globale variabler.

Syntaks

listvariables [-verbose] [-application application [-db database]]
Valg Forkortelse Beskrivelse
-verbose -v Viser udvidede beskrivelser.
-application -a Valgfrit. Applikationsnavn.
-database -db Valgfrit. Databasenavn (kube).

Eksempler

Kubeniveau

esscs listvariables -a Sample -db Basic

Applikationsniveau

esscs listvariables -a Sample

Globalt niveau

esscs listvariables

Setpassword: Gem CLI-ID-oplysninger

CLI-kommandoen setpassword for Essbase gemmer en adgangskode, der er tilknyttet din kombination af klient/bruger. I efterfølgende sessioner kan du logge på uden at indtaste en adgangskode.

Syntaks

 setpassword [-verbose] -essbaseurl URL -user userName
Valg Forkortelse Beskrivelse
-verbose -v Valgfrit. Viser udvidede beskrivelser
-essbaseurl -url Adressen på en instans af Essbase
-user -u Dit brugernavn

Bemærkninger

Efter migrering til release 21.4 eller nyere skal du nulstille eventuelle adgangskoder, der er gemt ved hjælp af denne kommando i en tidligere release.

Eksempel

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

Start: Start en applikation eller kube

CLI-kommandoen start starter en Essbase-applikation eller -kube og indlæser den i hukommelsen. For at køre denne kommando skal du mindst have tilladelsen Databaseadgang til applikationen.

Syntaks

start [-verbose] -application appname [-db cubename]
Valg Forkortelse Beskrivelse
-verbose -v Valgfrit. Viser udvidede beskrivelser
-application -a Applikationsnavn
-db -d Valgfrit. Databasenavn (kube)

Eksempel

esscs start -v -a Sample -d Basic

Stop: Stoppe en applikation eller kube

CLI-kommandoen stop stopper en Essbase-applikation eller -kube. For at køre denne kommando skal du mindst have tilladelsen Databaseadgang til applikationen.

Syntaks

stop [-verbose] -application appname [-db cubename]
Valg Forkortelse Beskrivelse
-verbose -v Valgfrit. Viser udvidede beskrivelser
-application -a Applikationsnavn
-db -d Valgfrit. Databasenavn (kube)

Eksempel

esscs stop -v -a Sample -d Basic

Unsetpassword: Fjern lagrede CLI-ID-oplysninger

CLI-kommandoen unsetpassword for Essbase fjerner lagrede logon-id-oplysninger, der er tilknyttet din kombination af klient/bruger, og tilbagefører virkningen af setpassword.

Syntaks

unsetpassword [-verbose] -essbaseurl URL -user userName
Valg Forkortelse Beskrivelse
-verbose -v Viser udvidede beskrivelser
-essbaseurl -url Adressen på en instans af Essbase
-user -u Den bruger, hvis adgangskode skal ophæves

Eksempel

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

Upload: Tilføje kubefiler

CLI-kommandoen upload uploader kubeartefakter fra et lokalt katalog til en instans af Essbase.

Hvis du vil udføre opgaver, som dataindlæsninger, dimensionsopbygninger, beregninger eller andre operationer, skal du muligvis uploade datafiler, regelfiler, beregningsscriptfiler eller andre artefakter til kubekataloget. Du kan også uploade artefakterne til dit brugerkatalog.

For at kunne uploade filer til en kube skal du som minimum have tilladelsen Databasestyring. Der kræves ingen særlige tilladelser for at uploade til dit brugerkatalog.

Bemærk:

Du kan aktivere antivirusscanning i Essbase-webinterfacet, så filer scannes for virus, før de uploades til serveren.

Syntaks

upload [-verbose] -file filename [-application appname [-db cubename] | -catalogpath catalogPath] [-overwrite] [-nocompression][-compressionalgorithm]
Valg Forkortelse Beskrivelse
-verbose -v Valgfrit. Viser udvidede beskrivelser
-file -f Navn på fil, der skal uploades

Bemærk:

Filtyper skal angives med små bogstaver. For eksempel filnavn.txt.
-application -a Valgfrit. Applikationsnavn. Hvis det ikke angives, uploades filerne til dit brugerkatalog eller den katalogsti, der er angivet i -CP.
-db -d Valgfrit. Databasenavn (kube). Kræver -a.
-catalogpath -CP Valgfrit. Katalogsti til filnavnet. Kan bruges i stedet for -a [-d] til angivelse af filens kataloglokation.
-overwrite -o Valgfrit. Overskriver den eksisterende fil
-nocompression -nc Valgfrit. Deaktiver komprimering af dataoverførsel
-compressionalgorithm -ca Valgfrit. Tilgængelig, hvis -nc ikke bruges. Definerer, hvilken komprimeringsalgoritme der skal bruges til dataoverførslen. Mulige valg: gzip eller lz4.

  • gzip - Standard, hvis komprimering bruges. Giver mindre dataoverførsel med langsommere beregning.

  • lz4 - Giver hurtigere beregning med en langsommere dataoverførsel.

Eksempler på brug:

-ca gzip
-ca lz4

Eksempler

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 også håndtere filer i Kubedesigner, Essbase-webinterfacet eller REST-API'en.

Version: Vis API-version

CLI-kommandoen version henter versionen af den REST-API, der er associeret med denne instans af Essbase.

Syntaks

version

Eksempel

esscs version