Referanse for CLI-kommandoer

Ved å bruke for eksempel følgende CLI-kommandoer for Essbase i esscs-skallet kan du utføre rutineoperasjoner for plattformen: calc, dataload, dimbuild, lcmexport, lcmimport, upload og download for artefakter, eller start og stop for en applikasjon eller kube.

Følgende kommandoer er tilgjengelige i kommandolinjegrensesnittet. Argumenter for kommandoer kan utstedes i hvilken som helst rekkefølge.

Hvis du vil vise hjelp for alle kommandoene, angir du esscs -h. Hvis du vil vise hjelp for en bestemt kommando, angir du esscs command -h.

Hvis du vil aktivere detaljerte utdata for kommandoer, som innebærer at eventuelle utvidede opplysninger vises, angir du esscs command -v command arguments.

Login/Logout: CLI-autentisering

CLI-kommandoen login for Essbase autentiserer deg for Essbase, slik at du kan bruke CLI.

Før du kan gi andre CLI-kommandoer i Essbase, må du logge på. Hvis en sikker tilkobling er nødvendig, må URL-adressen starte med https.

Du kan velge autentiseringstype på følgende måter ved hjelp av CLI:

  • Bruk setpassword én gang hvis du vil lagre passordet for kombinasjonen din av klient/bruker. I påfølgende økter kan du bruke kommandoen login uten å bli bedt om å angi et passord.
  • Bruk alternativene -user og -password med kommandoen login (Advarsel: Passordet vises i skallvinduet som klartekst).
  • Bruk bare alternativet -user med kommandoen login. Du blir bedt om å angi passordet, som er skjult.

Hvis du er en sammensluttet engangspåloggingsbruker i Oracle Identity Cloud Service, støttes ikke pålogging ved hjelp av MaxL eller CLI. Sammensluttet engangspålogging må utføres i et nettleservindu. Opprett en lokal Identity Cloud Service-bruker, og bruk i stedet denne til å logge på med MaxL eller CLI.

Syntaks (pålogging)

login [-verbose] -essbaseurl https://instance-name.example.com/essbase -user username [-password password]
Valg Forkortelse Beskrivelse
-verbose -v Vis utvidede beskrivelser
-essbaseurl -url Adressen til en forekomst av Essbase
-user -u Brukernavn
-password -p Valgfritt. Passord for bruker. Du kan eventuelt angi passordet ved hjelp av setpassword.

Hvis du utsteder påloggingskommandoen fra et skript og passordet inneholder spesialtegn, omslutter du det med doble anførselstegn (for eksempel "aNb3^5%9$!").

Bruk av tegnet $ (dollartegn) i Essbase-passordet støttes ikke for pålogginger i et Linux-miljø.

Eksempel 1 (pålogging)

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

Eksempel 2 (pålogging)

I det neste eksemplet er brukeren som logger på, admin1@example.com, en Identity Cloud Service-administrator som ble angitt som den innledende Essbase-administratoren under Essbase-stakkimplementering i Oracle Cloud Infrastructure. Ettersom passordet ikke angis i dette eksemplet, blir administratoren deretter bedt om å angi det. URL-adressen er essbase_url fra jobbutdataene som er resultater fra implementeringen av stakken.

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

Syntaks (avlogging)

logout

Eksempel (avlogging)

esscs logout

Calc: Kjøre et beregningsskript

CLI-kommandoen calc for Essbase utfører et beregningsskript på kuben. For å kunne kjøre denne kommandoen må du minst ha tillatelsen Databaseoppdatering samt klargjort tilgang til beregningsskriptet.

Før du kan kjøre beregningsskript, må du laste skriptene som CSC-filer til kubekatalogen. Du kan bruke CLI til å laste filene. Se Upload: Legge til kubefiler.

Syntaks

calc [-verbose] -application appname -db cubename -script scriptfilename
Valg Forkortelse Beskrivelse
-verbose -v Vis utvidede beskrivelser
-application -a Applikasjonsnavn
-db -d Navn på database (kube)
-script -s Navnet på beregningsskriptet. Må ha filtypen CSC. Du trenger ikke å angi en fullstendig bane. Det antas at filer ligger i den relevante kubekatalogen.

Eksempel

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

Du kan også kjøre beregningsskript ved hjelp av valget Beregn i Kubeutformer eller Smart View, Jobber i Web-grensesnittet for Essbase eller REST-API-et eller execute calculation i MaxL.

Clear: Fjerne data fra en kube

CLI-kommandoen clear for Essbase nullstiller data fra en kube. For å kunne bruke denne kommandoen må du minst ha tillatelsen Databaseoppdatering.

Syntaks

clear [-verbose] -application appname -db cubename [-option clearOption[-regionspec regionSpec]]
Valg Forkortelse Beskrivelse
-verbose -v Valgfritt. Vis utvidede beskrivelser
-application -a Applikasjonsnavn
-db -d Navn på database (kube)
-option -O Valgfritt. Nøkkelord som angir hva som skal nullstilles. Hvis det er utelatt, er standardvalget ALL_DATA.

Valgene for blokklagringskuber er:

  • ALL_DATA – Alle data, koblede objekter og disposisjonen nullstilles

  • UPPER_LEVEL – blokker på øvre nivå slettes

  • NON_INPUT – blokker uten inndata slettes

Valgene for kuber for aggregert lagring er:

  • ALL_DATA – Alle data, koblede objekter og disposisjonen nullstilles

  • ALL_AGGREGATIONS

    – Alle aggregerte data nullstilles

  • PARTIAL_DATA

    – Bare spesifisert dataområde nullstilles Bruk med -regionspec
-regionspec -rs MDX-uttrykk som angir området som skal nullstilles

Eksempel

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

Du kan også fjerne data ved hjelp av valget Last data i Kubeutformer, Jobber i Web-grensesnittet for Essbase eller REST-API-et eller alter database DBS-NAME reset i MaxL.

Createlocalconnection: Lagre en JDBC-tilkobling

CLI-kommandoen createlocalconnection for Essbase oppretter en JDBC-tilkobling og lagrer den lokalt. Du må ha rollen Tjenesteadministrator eller Privilegert bruker for å kunne bruke denne kommandoen.

Beskrivelse

En tjenesteadministrator må bruke denne kommandoen for å opprette og lagre den lokale tilkoblingen før noen kan bruke CLI-kommandoen dataload eller dimbuild med strømmingsvalget. Du må også angi miljøvariabelen EXTERNAL_CLASSPATH, slik at den peker til JAR-filen for databasedriveren (se Bygge dimensjoner og laste data ved strømming fra en ekstern database).

Syntaks

createLocalConnection [-verbose] -name streamConnection -connectionstring  connectionString -user userName [-driver jdbcDriver] [-password password]
Valg Forkortelse Beskrivelse
-verbose -v Vis utvidede beskrivelser
-name -N Tilkoblingsnavn
-connectionstring -cs JDBC-tilkoblingsstreng. Formatet kan være med tjenestenavn, som følger: 
jdbc:oracle:thin:@host:port/service_name

eller med SID, som følger:

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

Syntaksformatene ovenfor gjelder for Oracle Database. Se delen om eksempler hvis du vil ha informasjon om små forskjeller i syntaksen for tilkoblingsstrengen når du arbeider med andre leverandører.
-user -u Brukernavn
-driver -D JDBC-driver. Hvis denne ikke er angitt, regnes Oracle-databasen som standarden, som oracle.jdbc.driver.OracleDriver
-password -p Passord (valgfritt)

Hvis du har en nettverkstilkobling mellom en ekstern datakilde og Essbase, er det mest effektivt å definere tilkoblinger og datakilder på applikasjonsnivå eller globalt i Web-grensesnittet for Essbase. Disse definisjonene gjør det enklere å hente data fra den eksterne kilden. Hvis du ikke har en nettverkstilkobling mellom Essbase og den eksterne datakilden, kan du strømme datalastinger eller dimensjonsbygginger ved hjelp av CLI ved å først bruke denne kommandoen til å opprette en lokal tilkobling og deretter utstede kommandoen dataload eller dimbuild med strømmevalget.

Merknader

Etter migrering til versjon 21.4 eller nyere må tjenesteadministratoren opprette på nytt lagrede lokale tilkoblinger som ble opprettet ved hjelp av denne kommandoen i en tidligere versjon.

Eksempler

Hvis valget -driver og parameteren jdbcDriver ikke er angitt, er Oracle-databasen som standard den antatte databasen.

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 er angitt, er Oracle-databasen som standard den antatte databasen.

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 er angitt, er Oracle-databasen som standard den antatte databasen.

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 er angitt, er Oracle-databasen som standard den antatte databasen.

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 er angitt, er Oracle-databasen som standard den antatte databasen.

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 er angitt, er Oracle-databasen som standard den antatte databasen.

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

Dataload: Laste data til en kube

CLI-kommandoen dataload for Essbase laster data til en kube. For å kunne bruke denne kommandoen må du minst ha tillatelsen Databaseoppdatering.

Denne kommandoen må ha ett av følgende valgsett:

  • Datafil og valgfri regelfil

  • Regelfil med brukernavn og passord

  • Strømmingsvalg som refererer til en lagret lokal tilkobling

Kildedatabasen bør være tilgjengelig i klientnettverket ettersom ikke alle databasedrivere kan fungere med Java-proxyer.

Når du skal laste data, må du først laste opp datalasten og regelfilene til kubekatalogen. Du kan bruke CLI til å laste filene. Se Upload: Legge til 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 Vis utvidede beskrivelser
-application -a Applikasjonsnavn
-db -d Navn på database (kube)
-file -f Navn på datalastingsfil. Du trenger ikke å angi en fullstendig bane. Det antas at filer ligger i den relevante databasekatalogen. Du kan bruke -catalogfile i stedet for dette valget.
-rule -r Valgfritt. Navn på regelfil. Du trenger ikke å angi en fullstendig bane. Det antas at filer ligger i den relevante databasekatalogen. Du kan bruke -catalogrulefile i stedet for dette valget.
-catalogfile -CF Navn på datalastingsfil fra filkatalogen. Du kan bruke dette valget i stedet for -file.
-catalogrulefile -CRF Navn på regelfil fra filkatalogen. Du kan bruke dette valget i stedet for -rule.
-user -u Valgfritt. Brukernavn. Må ha passord hvis brukt.

Hvis du bruker en lagret tilkobling og datakilde, behøver du ikke å angi brukernavn og passord. Hvis du ikke bruker en lagret tilkobling og regelfilen skal kobles til en RDBMS, angir du brukernavnet og passordet for å koble til RDBMS.
-password -p Valgfritt. Passord for bruker. Hvis utelatt blir brukeren bedt om å angi passord.
-stream -S Valgfritt. Bruk strømmingsdatalasting. Må ha valget -conn hvis det brukes.
-connection -conn Obligatorisk hvis strømmingsvalget brukes. Navn på en lagret tilkobling som ble opprettet med CLI-kommandoen createlocalconnection.
-query -q Valgfritt. Databasespørring som skal sendes sammen med strømmingsdatalasten.
-rows -rows Valgfritt. Antall rader som skal strømmes samtidig. Standard er 100.
-abortOnError -abort Avbryt datalasting hvis det oppstår feil

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å laste data ved hjelp av kubeutformeren, Jobber i Web-grensesnittet for Essbase eller REST-API-et, eller importere data i MaxL.

Deletefile: Fjerne kubefiler

CLI-kommandoen deletefile for Essbase fjerner kubeartefakter fra hjemmekatalogen for applikasjon, database eller bruker. Hvis du vil slette filer fra en kube, trenger du minst tillatelsen Databasestyrer for kuben. Du trenger ingen spesielle tillatelser for å kunne slette filer fra brukerkatalogen din.

Syntaks

deletefile [-verbose] -file fileName [-application application [-db  database] [| -catalogfile catalogFile]]
Valg Forkortelse Beskrivelse
-verbose -v Vis utvidede beskrivelser
-file -f Navn på filen som skal slettes
-application -a Valgfritt. Applikasjonsnavn. Hvis dette ikke er angitt, antas det at filene ligger i hjemmekatalogen til brukeren din.
-database -db Valgfritt. Navn på database (kube)
-catalogfile -CF Filbane og -navn fra filkatalogen. Du kan bruke dette valget i stedet for -file.

Eksempler

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

Du kan også administrere filer i Kubeutformer, Web-grensesnittet for Essbase eller REST-API-et.

Implementere: Opprette en kube fra en arbeidsbok

CLI-kommandoen deploy for Essbase oppretter en kube fra en Excel-applikasjonsarbeidsbok. For å kunne kjøre denne kommandoen må du minst ha rollen Privilegert bruker.

Syntaks

deploy [-verbose] -file fileName [-application application [-database database] | -catalogfile catalogFile] [-restructureoption restructureOption] [-loaddata] [-recreateapplication] [-createfiles] [-executescript]
Valg Forkortelse Beskrivelse
-verbose -v Vis utvidede beskrivelser
-file -f Navnet på applikasjonsarbeidsbokfilen
-application -a Valgfritt. Applikasjonsnavn. Hvis dette ikke er angitt, hentes applikasjonsnavnet fra arbeidsboken.
-database -db Valgfritt. Navn på database (kube). Hvis dette ikke er angitt, hentes databasenavnet fra arbeidsboken.
-catalogfile -CF Applikasjonsarbeidsbok fra filkatalogen. Du kan bruke dette valget i stedet for -file.
-loaddata -l Valgfritt. Last data, hvis applikasjonsarbeidsboken inneholder et dataregneark. Hvis den ikke gjør det, importeres bare metadata til kuben.
-restructureoption -R Valgfritt. Nøkkelord som angir ønsket omstruktureringsalternativ.

Valgene for blokklagringskuber er:

  • ALL_DATA – behold alle data

  • NO_DATA – ikke behold noen data

  • LEAFLEVEL_DATA – behold data på nivå 0 (bladnivå)

  • INPUT_DATA – behold inndata

Valgene for kuber for aggregert lagring er:

  • ALL_DATA – behold alle data

  • NO_DATA – ikke behold noen data
-recreateapplication -ra Valgfritt. Opprett applikasjonen på nytt, hvis den allerede finnes
-createfiles -cf Valgfritt. Opprett kubeartefakter i filkatalogen i Essbase.
-executescript -e Valgfritt. Utfør beregningsskript. Gjelder bare hvis applikasjonsarbeidsboken inneholder et beregningsregneark med Kjør beregningsskript satt til Ja i definisjonene.

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 hjelp av Kubeutformer eller ved å bruke valget Importer i delen Applikasjoner i Web-grensesnittet for Essbase.

Dimbuild: Laste dimensjoner til en kube

CLI-kommandoen dimbuild for Essbase laster dimensjoner til en kube. For å kunne kjøre denne kommandoen må du minst ha tillatelsen Databasestyrer for kuben.

Før du kan laste dimensjoner, må du laste dimensjonsbygget og regelfilene til Essbase. Du kan bruke CLI til å laste filene. Se Upload: Legge til 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 Vis utvidede beskrivelser
-application -a Applikasjonsnavn
-db -d Navn på database (kube)
-file -f Filnavnet for dimensjonsbyggingen. Du trenger ikke å angi en fullstendig bane. Det antas at filene er i den aktuelle applikasjons- eller databasekatalogen. Du kan bruke -catalogfile i stedet for dette valget.
-rule -r Navn på regelfil. Du trenger ikke å angi en fullstendig bane. Det antas at filene er i den aktuelle applikasjons- eller databasekatalogen. Du kan bruke -catalogrulefile i stedet for dette valget.
-catalogfile -CF Filnavnet for dimensjonsbyggingen fra filkatalogen. Du kan bruke dette valget i stedet for -file.
-catalogrulefile -CRF Navn på regelfil fra filkatalogen. Du kan bruke dette valget i stedet for -rule.
-user -u Valgfritt. Brukernavn. Må ha passord hvis brukt.

Hvis du bruker en lagret tilkobling og datakilde, behøver du ikke å angi brukernavn og passord. Hvis du ikke bruker en lagret tilkobling og regelfilen skal kobles til en RDBMS, angir du brukernavnet og passordet for å koble til RDBMS.
-password -p Valgfritt. Passord for bruker. Hvis utelatt blir brukeren bedt om å angi passord.
-stream -S Valgfritt. Bruk dimensjonsbygging for strømming. Må ha valget -conn hvis det brukes.
-connection -conn Obligatorisk hvis strømmingsvalget brukes. Navn på en lagret tilkobling som ble opprettet med CLI-kommandoen createlocalconnection.
-query -q Valgfritt. Databasespørring som skal sendes sammen med strømmingsdimensjonsbyggingen.
-rows -rows Valgfritt. Antall rader som skal strømmes samtidig. Standard er 100.
-restructureOption -R

Kontrollerer bevaringsvalgene for omstruktureringen av disposisjonen.

For blokklagring finnes følgende mulige valg:

  • ALL_DATA: Behold alle data når du laster dimensjoner.
  • NO_DATA: Ikke behold data.
  • LEAFLEVEL_DATA: Behold bare dataverdier på nivå 0. Hvis alle dataene som er nødvendige for beregningen, ligger i nivå-0-medlemmer, må du angi dette valget. Alle blokker på øvre nivå slettes før kuben omstruktureres. Når kuben beregnes på nytt, opprettes blokkene på øvre nivå på nytt.
  • INPUT_DATA: Behold bare inndata.

For aggregert lagring finnes følgende mulige valg:

  • ALL_DATA: Behold alle data når du laster dimensjoner.
  • NO_DATA: Ikke behold data.
-forcedimbuild -F Fortsett med dimensjonsbyggingen selv om andre brukeraktiviteter pågår. Dette fører til at aktive brukerøkter avbrytes.

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å laste dimensjoner ved hjelp av kubeutformeren, Jobber i Web-grensesnittet for Essbase eller REST-API-et, eller importere dimensjoner i MaxL.

Download: Hente kubefiler

CLI-kommandoen download for Essbase laster ned kubeartefakter fra en Essbase-forekomst til en lokal katalog.

Det er mulig at du må laste ned tekstfiler, regelfiler eller beregningsskriptfiler fra en kube, slik at du kan jobbe med dem eller laste dem til en annen kube. Hvis du vil laste ned kubeartefakter, må du minst ha tillatelsen Databaseoppdatering.

Syntaks

download [-verbose] -file filename[ | -catalogfile catalogFile] [-application appname [-db cubename]] [-localdirectory path] [-overwrite] [-nocompression]
Valg Forkortelse Beskrivelse
-verbose -v Vis utvidede beskrivelser
-file -f Navnet på filen som skal lastes ned
-application -a Valgfritt. Applikasjonsnavn. Hvis dette ikke er oppgitt, lastes artefakter ned fra hjemmekatalogen til brukeren din.
-db -d Valgfritt. Navn på database (kube)
-catalogfile -CF Fil i filkatalogen. Du kan bruke dette valget i stedet for -file.
-localdirectory -ld Valgfritt. En lokal katalogbane
-overwrite -o Valgfritt. Overskriv eksisterende fil
-nocompression -nc Valgfritt. Deaktivere komprimering av dataoverføring

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å administrere filer i Kubeutformer, Web-grensesnittet for Essbase eller REST-API-et.

Hjelp: Vise kommandosyntaks

CLI-kommandoen help for Essbase viser hjelp på kommandonivå i konsollen eller terminalen.

Syntaks

[command] -help | -h

Eksempler

esscs -help
esscs -h
esscs dataload -help

LcmExport: Sikkerhetskopiere kubefiler

CLI-kommandoen lcmexport for Essbase sikkerhetskopierer applikasjoner og kubeartefakter i en ZIP-fil for Lifecycle Management (LCM), som den laster ned til lokal maskin. For å kunne kjøre denne kommandoen må du minst ha tillatelsen Applikasjonsstyrer.

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 Valgfritt. Vis utvidede beskrivelser.
-application -a Navnet på applikasjonen som skal sikkerhetskopieres.
-allApp -aa Valgfritt (og skiller mellom store og små bokstaver). Hvis dette brukes i stedet for -application, eksporteres alle applikasjoner til en enkelt ZIP-fil. LcmImport kan godta ZIP-filer med en enkelt applikasjon eller ZIP-filer med flere applikasjoner.
-zipfilename -z Valgfritt. Navnet på den komprimerte filen som skal inneholde sikkerhetskopifilene.
-localdirectory -ld Valgfritt. En lokal katalogbane. Hvis denne ikke er angitt, lagres ZIP-filen i <Applikasjonskatalog>/catalog/users/<brukernavn> på Essbase-tjeneren.
-threads -T Valgfritt. Antall tråder som startes ved bruk av parallell eksport. Minimum: 10
-skipdata -skip Valgfritt. Ikke inkluder data i sikkerhetskopien.
-overwrite -o Valgfritt. Overskriv eksisterende sikkerhetskopifil.
-generateartifactlist -gal Valgfritt. Generer en tekstfil som inneholder en fullstendig liste over de eksporterte artefaktene. Du kan bruke denne tekstfilen til å administrere import av artefakter. Du kan for eksempel endre rekkefølgen på artefaktene i listen slik at du kan styre importrekkefølgen. Du kan hoppe over import av enkelte artefakter ved å fjerne eller kommentere dem ut i listen.
-include-server-level -isl Valgfritt. Ta med globalt definerte tilkoblinger og datakilder.
-cube -c Valgfritt. Eksporter en enkelt kube. Dette alternativet kan angis sammen med alternativene for eksport av bare data, filer av bestemte typer, partisjoner eller filtre.
-exportdata -d Valgfritt. Eksporter bare data.
-filetype -ft

Valgfritt. Eksporter bare filer av den angitte typen. Støttede filtyper er OTL (disposisjon), TXT (tekst), RUL (regel), CSC (beregningsskript), DTR (definisjon av gjennomdrillingsrapport) og Excel. (Bare 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

Valgfritt. Eksporter bare partisjonsdefinisjoner.

Importoperasjoner for Lifecycle Management (LCM) (og import med migreringsverktøyet) støttes ikke for migrering av sammensluttede partisjoner. Sammensluttede partisjoner må opprettes på nytt manuelt på målet.
-exportfilters -ef Valgfritt. Eksporter bare sikkerhetsfiltre.
-restEncryPassword -encryPwd

Hvis applikasjonen er kryptert, er dette et passord for å beskytte den krypterte applikasjonen under migrering. Passordet må inneholde mellom 6 og 15 tegn, og det kan ikke inneholde noen av følgende spesialtegn: ?=.,*!@#&()[{}]:;'/~$^+<>-

Advarsel: Hvis dette passordet glemmes, er det ikke mulig å hente det frem, og applikasjonen kan ikke importeres.

Merknader

Denne kommandoen kan, i likhet med andre CLI-kommandoer, brukes fra utsiden av Essbase-maskinen, mens LCM-verktøyet må kjøres fra Essbase-maskinen.

Eksempel

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

Eksempel på Windows-skript

Følgende Windows-skript, lcmexportall.bat, eksporterer alle applikasjoner til gjeldende lokal katalog som CLI er kalt 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: Gjenopprette kubefiler

CLI-kommandoen lcmimport for Essbase gjenoppretter kubeartefakter fra en ZIP-fil for Lifecycle Management (LCM). For å kunne kjøre denne kommandoen må du være den privilegerte brukeren som opprettet applikasjonen, eller tjenesteadministrator.

Syntaks

lcmImport [-verbose] -zipfilename filename [-overwrite] [-targetappName targetApplicationName][-include-server-level][-artifactlist artifactList][-restEncryPassword]
Valg Forkortelse Beskrivelse
-verbose -v Valgfritt. Vis utvidede beskrivelser
-zipfilename -z Navn på komprimert fil som inneholder sikkerhetskopifiler
-overwrite -o Valgfritt. Opprett målapplikasjonen på nytt.
-targetappName -ta Valgfritt. Målapplikasjonsnavn, hvis du vil at det skal være forskjellig fra kildenavnet.
-artifactlist -al Valgfritt. Navn på filen som inneholder listen over artefakter som skal importeres. Denne filen kan genereres fra lcmexport.

Hvis du vil hoppe over artefakter, kan du kommentere ut eller slette oppføringer fra listen. Hvis du for eksempel vil hoppe over import av revisjonsposter, kommenterer du ut denne linjen, som vist her:

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

Hvis du vil styre importrekkefølgen, endrer du rekkefølgen på import-oppføringene i tekstfilen.

Hvis –overwrite er brukt, sletter og gjenoppretter importoperasjonen hele applikasjonen, og importerer bare artefaktene som finnes i listen. Hvis –overwrite ikke er brukt, inkluderer importoperasjonen artefaktene som er angitt i listen, uten å påvirke noen andre artefakter som allerede finnes i målapplikasjonen.
-include-server-level -isl Valgfritt. Ta med globalt definerte tilkoblinger og datakilder.
-restEncryPassword -encryPwd

Hvis applikasjonen er kryptert, er dette et passord for å beskytte den krypterte applikasjonen under migrering. Passordet må inneholde mellom 6 og 15 tegn, og det kan ikke inneholde noen av følgende spesialtegn: ?=.,*!@#&()[{}]:;'/~$^+<>-

Advarsel: Hvis dette passordet glemmes, er det ikke mulig å hente det frem, og applikasjonen kan ikke importeres.

Merknader

  • Denne kommandoen kan, i likhet med andre CLI-kommandoer, brukes fra utsiden av Essbase-maskinen, mens LCM-verktøyet må kjøres fra Essbase-maskinen.

  • Når LCM-importen er fullført, må du kanskje utføre flere handlinger for å gjenopprette migrerte tilkoblinger til eksterne kilder. Hvis du vil gjøre dette, åpner du tilkoblingen og angir passordet.

  • Når det finnes partisjoner mellom kuber som migreres, må du importere datakilden før datamålet. Ellers blir kanskje ikke partisjonsdefinisjonene gjenopprettet.

    Importoperasjoner for Lifecycle Management (LCM) (og import med migreringsverktøyet) støttes ikke for migrering av sammensluttede partisjoner. Sammensluttede partisjoner må opprettes på nytt manuelt på målet.

  • LCM-import migrerer ikke påloggingsopplysninger for plasseringsalias. Du må erstatte påloggingsopplysningene for plasseringsalias, enten ved å opprette plasseringsaliaser på nytt ved hjelp av MaxL eller ved å redigere påloggingsopplysningene for plasseringsalias i XML-en som eksporteres ved LCM-eksport.

Eksempel

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

Listapp: Vise applikasjoner

CLI-kommandoen listapp viser applikasjonene du har tilgang til i denne Essbase-forekomsten.

Syntaks

listapp [-verbose] [-details]
Valg Forkortelse Beskrivelse
-verbose -v Valgfritt. Vis utvidede beskrivelser
-details -dtl Valgfritt. Vis flere detaljer i utdataene (applikasjonstype og gjeldende status).

Eksempel

esscs listapp -v -dtl

Listdb: Vise kuber

CLI-kommandoen listdb viser databaser du har tilgang til i en angitt Essbase-applikasjon.

Syntaks

listdb [-verbose] -application applicationName [details]
Valg Forkortelse Beskrivelse
-verbose -v Valgfritt. Vis utvidede beskrivelser
-application -a Applikasjonsnavn
-details -dtl Valgfritt. Vis statusdetaljer i utdataene

Eksempel

esscs listdb -v -a Sample -dtl

Listfiles: Vise filer

CLI-kommandoen listfiles viser kubeartefaktene som finnes i en Essbase-forekomst.

Kubeartefakter kan inneholde datafiler, arbeidsbøker, regelfiler, beregningsskriptfiler eller andre artefakter. Kubeartefakter omfatter filer du trenger når du skal utføre handlinger for applikasjoner og kuber.

Hvis du vil vise filer for en kube, må du minst ha tillatelsen Databasetilgang for applikasjonen. Du trenger ingen spesielle tillatelser for å kunne vise filer fra brukerkatalogen din.

Syntaks

listfiles [-verbose] [-type filetype] [-application appname [-db cubename] | -catalogpath catalogPath]
Valg Forkortelse Beskrivelse
-verbose -v Valgfritt. Vis utvidede beskrivelser
-type -t Valgfritt. Filtype som skal vises, uten punktum.

Følgende filtyper støttes:

  • .csc (beregningsskript)
  • .rul (regelfiler)
  • .txt (tekstfiler)
  • .msh (MaxL-skript)
  • .xls, .xlsx (Excel-arbeidsbøker)
  • .xlsm (makroaktiverte Excel-arbeidsbøker)
  • .xml (XML-filer)
  • .zip (komprimerte ZIP-filer)
  • .csv (kommadelte filer)
-application -a Valgfritt. Applikasjonsnavn. Hvis dette ikke er oppgitt, vises det filer fra hjemmekatalogen til brukeren din.
-db -d Valgfritt. Navn på database (kube)
-catalogpath -CP Valgfritt. Katalogbane til filnavnet. Kan brukes i stedet for -a [-d] til å angi katalogplasseringen for filen(e).

Eksempler

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

Du kan også administrere filer i Kubeutformer, Web-grensesnittet for Essbase eller REST-API-et.

Listfilters: Vise sikkerhetsfiltre

CLI-kommandoen listfilters viser en liste over sikkerhetsfiltre for Essbase. Du må minst ha tillatelsen Databasestyrer for applikasjonen hvis du vil vise filtre for kuber i applikasjonen.

Syntaks

listfilters [-verbose] -application appname -db cubename
Valg Forkortelse Beskrivelse
-verbose -v Valgfritt. Vis utvidede beskrivelser
-application -a Applikasjonsnavn
-db -d Navn på database (kube)

Eksempel

esscs listfilters -v -a Sample -d Basic

Listlocks: Vise låser

CLI-kommandoen listlocks for Essbase viser eventuelle låste datablokker eller kuberelaterte objekter. For å kunne kjøre denne kommandoen må du minst ha tillatelsen Databasetilgang for applikasjonen.

Syntaks

listlocks [-verbose] -application appname -db cubename [-object]
Valg Forkortelse Beskrivelse
-verbose -v Valgfritt. Vis utvidede beskrivelser
-application -a Applikasjonsnavn
-db -d Navn på database (kube)
-object -obj Valgfritt. Vis låste filer/artefakter.

Eksempel

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

Listvariables: Vise erstatningsvariabler

CLI-kommandoen listvariables for Essbase viser erstatningsvariabler definert for omfanget for kuben eller applikasjonen eller globalt. Du må minst ha tillatelsen Databasetilgang for å kunne se variabler for en kube, rollen Applikasjonsstyrer for å kunne se variabler for en applikasjon og rollen Tjenesteadministrator for å kunne se globale variabler.

Syntaks

listvariables [-verbose] [-application application [-db database]]
Valg Forkortelse Beskrivelse
-verbose -v Vis utvidede beskrivelser.
-application -a Valgfritt. Applikasjonsnavn.
-database -db Valgfritt. Navn på database (kube).

Eksempler

Kubenivå

esscs listvariables -a Sample -db Basic

Applikasjonsnivå

esscs listvariables -a Sample

Globalt nivå

esscs listvariables

Setpassword: Lagre påloggingsopplysninger for CLI

CLI-kommandoen setpassword for Essbase lagrer et passord knyttet til den aktuelle kombinasjonen av klient og bruker. I påfølgende økter kan du logge på uten å måtte angi et passord.

Syntaks

 setpassword [-verbose] -essbaseurl URL -user userName
Valg Forkortelse Beskrivelse
-verbose -v Valgfritt. Vis utvidede beskrivelser
-essbaseurl -url Adressen til en forekomst av Essbase
-user -u Brukernavnet ditt

Merknader

Etter migrering til versjon 21.4 eller nyere må du tilbakestille lagrede passord som ble lagret ved hjelp av denne kommandoen i en tidligere versjon.

Eksempel

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

Start: Starte en applikasjon eller kube

CLI-kommandoen start starter en Essbase-applikasjon eller -kube og laster den inn i minnet. For å kunne kjøre denne kommandoen må du minst ha tillatelsen Databasetilgang for applikasjonen.

Syntaks

start [-verbose] -application appname [-db cubename]
Valg Forkortelse Beskrivelse
-verbose -v Valgfritt. Vis utvidede beskrivelser
-application -a Applikasjonsnavn
-db -d Valgfritt. Navn på database (kube)

Eksempel

esscs start -v -a Sample -d Basic

Stop: Stoppe en applikasjon eller kube

CLI-kommandoen stop stopper en Essbase-applikasjon eller -kube. For å kunne kjøre denne kommandoen må du minst ha tillatelsen Databasetilgang for applikasjonen.

Syntaks

stop [-verbose] -application appname [-db cubename]
Valg Forkortelse Beskrivelse
-verbose -v Valgfritt. Vis utvidede beskrivelser
-application -a Applikasjonsnavn
-db -d Valgfritt. Navn på database (kube)

Eksempel

esscs stop -v -a Sample -d Basic

Unsetpassword: Fjerne lagrede påloggingsopplysninger for CLI

CLI-kommandoen unsetpassword for Essbase fjerner lagrede påloggingsopplysninger knyttet til den aktuelle kombinasjonen av klient og bruker, slik at virkningen av setpassword omgjøres.

Syntaks

unsetpassword [-verbose] -essbaseurl URL -user userName
Valg Forkortelse Beskrivelse
-verbose -v Vis utvidede beskrivelser
-essbaseurl -url Adressen til en forekomst av Essbase
-user -u Brukeren som har et passord som skal oppheves

Eksempel

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

Upload: Legge til kubefiler

CLI-kommandoen upload laster kubeartefakter fra en lokal katalog til en Essbase-forekomst.

Når du skal utføre oppgaver som datalastinger, dimensjonsbygginger, beregninger eller andre operasjoner, kan det hende at du må laste datafiler, regelfiler, beregningsskriptfiler eller andre artefakter til kubekatalogen. Du kan også laste opp artefakter til brukerkatalogen din.

Hvis du vil laste filer til en kube, må du minst ha tillatelsen Databasestyrer. Du trenger ingen spesielle tillatelser for å kunne laste opp filer til brukerkatalogen din.

Merknad:

Du kan aktivere virusskanning i Web-grensesnittet for Essbase slik at filer skannes for virus før de lastes opp til tjeneren.

Syntaks

upload [-verbose] -file filename [-application appname [-db cubename] | -catalogpath catalogPath] [-overwrite] [-nocompression][-compressionalgorithm]
Valg Forkortelse Beskrivelse
-verbose -v Valgfritt. Vis utvidede beskrivelser
-file -f Navn på fil som skal lastes opp

Merknad:

Filtyper må være angitt med små bokstaver. Eksempel: filnavn.txt.
-application -a Valgfritt. Applikasjonsnavn. Hvis dette valget ikke angis, lastes filer til brukerkatalogen eller katalogbanen angitt i -CP.
-db -d Valgfritt. Navn på database (kube). Må ha -a.
-catalogpath -CP Valgfritt. Katalogbane til filnavnet. Kan brukes i stedet for -a [-d] til å angi katalogplasseringen for filen.
-overwrite -o Valgfritt. Overskriv eksisterende fil
-nocompression -nc Valgfritt. Deaktivere komprimering av dataoverføring
-compressionalgorithm -ca Valgfritt. Tilgjengelig hvis -nc ikke brukes. Definerer hvilken komprimeringsalgoritme som skal brukes til dataoverføring. Mulige valg: gzip eller lz4.

  • gzip – standard hvis komprimering brukes. Tilbyr mindre dataoverføring med saktere beregning.

  • lz4 – tilbyr raskere beregning med saktere dataoverføring.

Brukseksempler:

-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å administrere filer i Kubeutformer, Web-grensesnittet for Essbase eller REST-API-et.

Versjon: Vise API-versjon

CLI-kommandoen version henter versjonen av REST-API-et som er knyttet til denne Essbase-forekomsten.

Syntaks

version

Eksempel

esscs version