CLI Command Reference

De CLI-opdrachten van Essbase die u uitvoert in de shell esscs helpen bij het uitvoeren van routinematige platformbewerkingen, zoals: 'calc', 'dataload', 'dimbuild', 'lcmexport', 'lcmimport', uploaden en downloaden van artefacten en starten en stoppen van een applicatie of kubus.

In de opdrachtregelinterface zijn de volgende opdrachten beschikbaar. Argumenten voor opdrachten kunnen in elke gewenste volgorde worden uitgegeven.

Typ esscs -h om Help-informatie weer te geven voor alle opdrachten. Typ esscs opdracht -h om Help-informatie weer te geven voor een specifieke opdracht.

Typ esscs opdracht -v opdrachtargumenten om verbose-uitvoer in te schakelen voor elke opdracht. Dit betekent dat er uitgebreide informatie wordt weergegeven, indien beschikbaar.

Inloggen/Uitloggen: CLI-verificatie

Met de CLI-opdracht login voor Essbase wordt u geverifieerd bij Essbase zodat u de CLI kunt gebruiken.

U moet inloggen voordat u andere CLI-opdrachten naar Essbase kunt sturen. Als een veilige verbinding is vereist, moet de URL beginnen met https.

U kunt de verificatie op de volgende manieren uitvoeren met CLI:

  • Gebruik eenmalig setpassword om het wachtwoord voor uw combinatie van client en gebruiker op te slaan. In volgende sessies kunt u de opdracht login gebruiken zonder dat u wordt gevraagd om uw wachtwoord in te voeren.
  • Gebruik de opties -user en -password met de opdracht login (voorzichtig: het wachtwoord wordt in het shell-venster weergegeven als gewone tekst).
  • Gebruik alleen de optie -user met de opdracht login. U wordt gevraagd het wachtwoord in te voeren en dat wordt verborgen.

Als u een geconsolideerde SSO-gebruiker in Oracle Identity Cloud Service bent, wordt inloggen met MaxL of CLI niet ondersteund. Voor geconsolideerd SSO inloggen is een browservenster vereist. Maak een native Identity Cloud Service gebruiker en gebruik deze om in te loggen met MaxL of CLI.

Syntaxis (inloggen)

login [-verbose] -essbaseurl https://instance-name.example.com/essbase -user username [-password password]
Optie Afkorting Beschrijving
-verbose -v Uitgebreide beschrijvingen tonen
-essbaseurl -url Adres van een instance van Essbase
-user -u Gebruikersnaam
-password -p Optioneel. Wachtwoord voor de gebruiker. U kunt het wachtwoord ook instellen met setpassword.

Als u de inlogopdracht vanuit een script opgeeft en het wachtwoord speciale tekens bevat, plaatst u het wachtwoord tussen dubbele aanhalingstekens (bijvoorbeeld "aNb3^5%9$!").

Het gebruik van het teken $ (dollarteken) in een Essbase wachtwoord wordt niet ondersteund voor aanmeldingen in een Linux-omgeving.

Voorbeeld 1 (inloggen)

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

Voorbeeld 2 (inloggen)

In het volgende voorbeeld is de gebruiker die inlogt, admin1@example.com een Identity Cloud Service beheerder die is ingesteld als de initiële Essbase beheerder tijdens Essbase stackimplementatie in Oracle Cloud Infrastructure. Omdat het wachtwoord niet is ingevoerd in dit voorbeeld, wordt de beheerder gevraagd dit op te geven. De URL is de essbase_url van de taakuitvoergegevens die het resultaat zijn van de stackimplementatie.

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

Syntaxis (uitloggen)

logout

Voorbeeld (uitloggen)

esscs logout

Calc: berekeningsscript uitvoeren

Met de CLI-opdracht calc voor Essbase wordt een rekenscript uitgevoerd op de kubus. Als u deze opdracht wilt uitvoeren, hebt u ten minste het recht 'Database bijwerken' nodig, en gefaciliteerde toegang tot het rekenscript.

Voordat u rekenscripts kunt uitvoeren, moet u de scripts eerst uploaden (als .csc-bestanden) naar de kubusdirectory. U kunt de CLI gebruiken om bestanden te laden. Zie voor meer informatie: Upload: kubusbestanden toevoegen.

Syntaxis

calc [-verbose] -application appname -db cubename -script scriptfilename
Optie Afkorting Beschrijving
-verbose -v Uitgebreide beschrijvingen tonen
-application -a Applicatienaam
-db -d Naam database (kubus)
-script -s Naam berekeningsscript. Moet bestandsextensie .csc hebben. U hoeft niet een volledig pad op te geven. Er wordt aangenomen dat de bestanden in de relevante kubusdirectory staan.

Voorbeeld

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

U kunt ook berekeningsscripts uitvoeren met de optie 'Berekenen' in Cube Designer of Smart View, 'Taken' in de Essbase-webinterface of REST-API, of execute calculation in MaxL.

Clear: gegevens uit een kubus verwijderen

Met de CLI-opdracht clear voor Essbase worden gegevens gewist uit een kubus. Als u deze opdracht wilt gebruiken, moet u minstens het recht 'Database bijwerken' hebben.

Syntaxis

clear [-verbose] -application appname -db cubename [-option clearOption[-regionspec regionSpec]]
Optie Afkorting Beschrijving
-verbose -v Optioneel. Uitgebreide beschrijvingen tonen
-application -a Applicatienaam
-db -d Naam database (kubus)
-option -O Optioneel. Sleutelwoord waarmee u aangeeft wat er moet worden gewist Als niets wordt opgegeven, is de standaardoptie ALL_DATA.

De opties voor blokopslagkubussen zijn:

  • ALL_DATA: alle gegevens, gekoppelde objecten en de structuur worden gewist.

  • UPPER_LEVEL: blokken op het hoogste niveau worden gewist.

  • NON_INPUT: niet-invoerblokken worden gewist.

De opties voor kubussen voor geaggregeerde opslag zijn:

  • ALL_DATA: alle gegevens, gekoppelde objecten en de structuur worden gewist.

  • ALL_AGGREGATIONS

    : alle geaggregeerde gegevens worden gewist.

  • PARTIAL_DATA

    : alleen de opgegeven gegevensregio wordt gewist. Gebruik met -regionspec
-regionspec -rs MDX-uitdrukking waarmee wordt aangegeven welke regio moet worden gewist

Voorbeeld

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

U kunt ook gegevens wissen met de optie 'Gegevens laden' in Cube Designer, 'Taken' in de webinterface van Essbase of REST-API, of alter database DBS-NAME reset in MaxL.

Createlocalconnection: een JDBC-verbinding opslaan

Met de CLI-opdracht createlocalconnection voor Essbase wordt een JDBC-verbinding gemaakt en lokaal opgeslagen. Als u deze opdracht wilt gebruiken, moet u de rol 'Servicebeheerder' of 'Hoofdgebruiker' hebben.

Beschrijving

Een servicebeheerder moet deze opdracht gebruiken om de lokale verbinding te maken en op te slaan voordat iemand de CLI-opdracht dataload or dimbuild kan gebruiken met de streamingoptie. U moet ook de omgevingsvariabele EXTERNAL_CLASSPATH zo instellen dat deze wijst naar het .jar-bestand voor uw databasedriver (zie Dimensies opbouwen en gegevens laden door middel van streaming vanuit een externe database).

Syntaxis

createLocalConnection [-verbose] -name streamConnection -connectionstring  connectionString -user userName [-driver jdbcDriver] [-password password]
Optie Afkorting Beschrijving
-verbose -v Uitgebreide beschrijvingen tonen
-name -N Verbindingsnaam
-connectionstring -cs JDBC-verbindingsstring. Opmaak kan met servicenaam zijn, als volgt: 
jdbc:oracle:thin:@host:port/service_name

of met SID, als volgt:

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

De bovenstaande notaties zijn van toepassing op Oracle Database. Zie de sectie 'Voorbeelden' voor kleine verschillen in de syntaxis van de verbindingsstring wanneer u met andere leveranciers werkt.
-user -u Gebruikersnaam
-driver -D JDBC-driver. Als deze niet wordt opgegeven, wordt Oracle Database als de standaardwaarde beschouwd, als oracle.jdbc.driver.OracleDriver
-password -p Wachtwoord (optioneel)

Als u netwerkconnectiviteit hebt tussen een externe gegevensbron en Essbase, is het het meest efficiënt om verbindingen op applicatieniveau of algemene verbindingen en gegevensbronnen te definiëren in de Essbase webinterface. Met behulp van deze definities kunt u gemakkelijk gegevens uit de externe bron "trekken". Als er geen netwerkverbinding tussen Essbase en de externe gegevensbron is, kunt u het laden van gegevens of het opbouwen van dimensies streamen met CLI. Hiervoor moet u met deze opdracht eerst een lokale verbinding maken en vervolgens de opdracht 'dataload' of 'dimbuild' uitvoeren met de stream-optie.

Notities

Na de migratie naar versie 21.4 of hoger moet de servicebeheerder opgeslagen lokale verbindingen opnieuw maken die met deze opdracht zijn gemaakt in een vorige versie.

Voorbeelden

Als de optie -driver en de parameter jdbcDriver niet worden opgegeven, wordt standaard aangenomen dat de Oracle database moet worden gebruikt.

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

Als de optie -driver en de parameter jdbcDriver niet worden opgegeven, wordt standaard aangenomen dat de Oracle database moet worden gebruikt.

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

Als de optie -driver en de parameter jdbcDriver niet worden opgegeven, wordt standaard aangenomen dat de Oracle database moet worden gebruikt.

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

Als de optie -driver en de parameter jdbcDriver niet worden opgegeven, wordt standaard aangenomen dat de Oracle database moet worden gebruikt.

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

Als de optie -driver en de parameter jdbcDriver niet worden opgegeven, wordt standaard aangenomen dat de Oracle database moet worden gebruikt.

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

Als de optie -driver en de parameter jdbcDriver niet worden opgegeven, wordt standaard aangenomen dat de Oracle database moet worden gebruikt.

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

Dataload: gegevens naar een kubus laden

Met de CLI-opdracht dataload voor Essbase worden gegevens geladen naar een kubus. Als u deze opdracht wilt gebruiken, moet u minstens het recht 'Database bijwerken' hebben.

Voor deze opdracht is een van de volgende sets met opties vereist:

  • Gegevensbestand en optioneel regelbestand

  • Regelbestand met gebruikersnaam en wachtwoord

  • Streamingoptie die verwijst naar een opgeslagen lokale verbinding

De brondatabase moet toegankelijk zijn binnen het clientnetwerk, omdat niet alle databasestuurprogramma's met Java-proxy's kunnen werken.

Om gegevens te kunnen laden, moet u eerst het bestand voor het laden van de gegevens en het regelbestand uploaden naar de kubusdirectory. U kunt de CLI gebruiken om bestanden te laden. Zie voor meer informatie: Upload: kubusbestanden toevoegen.

Syntaxis

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]
Optie Afkorting Beschrijving
-verbose -v Uitgebreide beschrijvingen tonen
-application -a Applicatienaam
-db -d Naam database (kubus)
-file -f Naam gegevenslaadbestand. U hoeft niet een volledig pad op te geven. Er wordt aangenomen dat de bestanden in de relevante databasedirectory staan. In plaats van deze optie kunt u -catalogfile gebruiken.
-rule -r Optioneel. Naam regelbestand U hoeft niet een volledig pad op te geven. Er wordt aangenomen dat de bestanden in de relevante databasedirectory staan. In plaats van deze optie kunt u -catalogrulefile gebruiken.
-catalogfile -CF Naam gegevenslaadbestand uit de bestandscatalogus. U kunt deze optie gebruiken in plaats van -file.
-catalogrulefile -CRF Naam regelbestand uit de bestandscatalogus. U kunt deze optie gebruiken in plaats van -rule.
-user -u Optioneel. Gebruikersnaam. Als deze wordt gebruikt, is een wachtwoord vereist.

Als u een opgeslagen verbinding en gegevensbron gebruikt, hoeft u geen gebruikersnaam en wachtwoord op te geven. Als u geen opgeslagen verbinding gebruikt en het regelbestand verbinding maakt met een RDBMS, geeft u de gebruikersnaam en het wachtwoord op om verbinding te maken met de RDBMS.
-password -p Optioneel. Wachtwoord voor de gebruiker. Als dit wordt weggelaten, wordt de gebruiker om een wachtwoord gevraagd.
-stream -S Optioneel. Streaming gebruiken voor het laden van gegevens. Wanneer dit wordt gebruikt, is de optie '-conn' vereist.
-connection -conn Vereist als de optie 'stream' wordt gebruikt. Naam van een opgeslagen verbinding die is gemaakt met de createlocalconnection CLI-opdracht.
-query -q Optioneel. Databasezoekvraag die samen met de streaminggegevensbelasting moet worden verstuurd.
-rows -rows Optioneel. Aantal tegelijk te streamen rijen. De standaardwaarde is 100.
-abortOnError -abort Laden van gegevens afbreken zodra er een fout optreedt

Voorbeelden

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"

U kunt ook gegevens laden via Cube Designer, 'Taken' in de Essbase webinterface of REST-API, of gegevens importeren in MaxL.

Deletefile: kubusbestanden verwijderen

Met de CLI-opdracht deletefile voor Essbase worden kubusartefacten verwijderd uit de applicatie, de database of de basisdirectory van de gebruiker. Als u bestanden wilt verwijderen uit een kubus, hebt u ten minste het toegangsrecht 'Databasebeheer' nodig voor de kubus. Er zijn geen speciale rechten vereist om bestanden te verwijderen uit uw gebruikersdirectory.

Syntaxis

deletefile [-verbose] -file fileName [-application application [-db  database] [| -catalogfile catalogFile]]
Optie Afkorting Beschrijving
-verbose -v Uitgebreide beschrijvingen tonen
-file -f Naam van het te verwijderen bestand
-application -a Optioneel. Applicatienaam. Als niets wordt opgegeven, wordt ervan uitgegaan dat de bestanden in de basisdirectory van de gebruiker staan.
-database -db Optioneel. Naam database (kubus)
-catalogfile -CF Bestandspad en -naam uit de bestandscatalogus. U kunt deze optie gebruiken in plaats van -file.

Voorbeelden

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

U kunt ook bestanden beheren in Cube Designer, de webinterface van Essbase of REST-API.

Deploy: een kubus maken op basis van een werkboek

Met de CLI-opdracht deploy voor Essbase wordt een kubus gemaakt van een Excel-applicatiewerkmap. Als u deze opdracht wilt uitvoeren, moet u minstens de rol 'Hoofdgebruiker' hebben.

Syntaxis

deploy [-verbose] -file fileName [-application application [-database database] | -catalogfile catalogFile] [-restructureoption restructureOption] [-loaddata] [-recreateapplication] [-createfiles] [-executescript]
Optie Afkorting Beschrijving
-verbose -v Uitgebreide beschrijvingen tonen
-file -f Bestandsnaam van het applicatiewerkboek
-application -a Optioneel. Applicatienaam. Als deze niet wordt opgegeven, wordt de applicatienaam uit het werkboek gehaald.
-database -db Optioneel. Naam database (kubus). Als deze niet wordt opgegeven, wordt de databasenaam uit het werkboek gehaald.
-catalogfile -CF Applicatiewerkboek uit de bestandscatalogus. U kunt deze optie gebruiken in plaats van -file.
-loaddata -l Optioneel. Gegevens laden als het applicatiewerkboek een gegevenswerkblad bevat. Anders worden er alleen metagegevens in de kubus geïmporteerd.
-restructureoption -R Optioneel. Sleutelwoord waarmee de gewenste herstructureringsoptie wordt aangegeven.

De opties voor blokopslagkubussen zijn:

  • ALL_DATA: alle gegevens behouden

  • NO_DATA: geen gegevens behouden

  • LEAFLEVEL_DATA: gegevens op niveau 0 (eindnodeniveau) behouden

  • INPUT_DATA: invoergegevens behouden

De opties voor kubussen voor geaggregeerde opslag zijn:

  • ALL_DATA: alle gegevens behouden

  • NO_DATA: geen gegevens behouden
-recreateapplication -ra Optioneel. De applicatie opnieuw maken als deze al bestaat
-createfiles -cf Optioneel. Kubusartefacten maken in de bestandsdirectory in Essbase.
-executescript -e Optioneel. Berekeningsscripts uitvoeren. Alleen van toepassing als het applicatiewerkboek een rekenwerkblad bevat waarvoor Berekening uitvoeren is ingesteld op 'Ja' in de definities.

Voorbeelden

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

U kunt ook kubussen implementeren met Cube Designer of via de optie 'Importeren' in de sectie Applicaties van de Essbase-webinterface.

Dimbuild: dimensies naar een kubus laden

Met de CLI-opdracht dimbuild voor Essbase worden dimensies geladen naar een kubus. Als u deze opdracht wilt uitvoeren, moet u minstens het recht 'Databasebeheer' hebben voor de kubus.

Voordat u dimensies kunt laden, moet u eerst het bestand voor dimensieopbouw en regelbestanden uploaden naar Essbase. U kunt de CLI gebruiken om bestanden te laden. Zie voor meer informatie: Upload: kubusbestanden toevoegen.

Syntaxis

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]
Optie Afkorting Beschrijving
-verbose -v Uitgebreide beschrijvingen tonen
-application -a Applicatienaam
-db -d Naam database (kubus)
-file -f Naam bestand voor opbouwen dimensie. U hoeft niet een volledig pad op te geven. Er wordt aangenomen dat de bestanden in de relevante applicatie- of databasedirectory staan. In plaats van deze optie kunt u -catalogfile gebruiken.
-rule -r Naam regelbestand U hoeft niet een volledig pad op te geven. Er wordt aangenomen dat de bestanden in de relevante applicatie- of databasedirectory staan. In plaats van deze optie kunt u -catalogrulefile gebruiken.
-catalogfile -CF Naam bestand voor opbouwen dimensie uit de bestandscatalogus. U kunt deze optie gebruiken in plaats van -file.
-catalogrulefile -CRF Naam regelbestand uit de bestandscatalogus. U kunt deze optie gebruiken in plaats van -rule.
-user -u Optioneel. Gebruikersnaam. Als deze wordt gebruikt, is een wachtwoord vereist.

Als u een opgeslagen verbinding en gegevensbron gebruikt, hoeft u geen gebruikersnaam en wachtwoord op te geven. Als u geen opgeslagen verbinding gebruikt en het regelbestand verbinding maakt met een RDBMS, geeft u de gebruikersnaam en het wachtwoord op om verbinding te maken met de RDBMS.
-password -p Optioneel. Wachtwoord voor de gebruiker. Als dit wordt weggelaten, wordt de gebruiker om een wachtwoord gevraagd.
-stream -S Optioneel. Streaming gebruiken bij opbouwen van dimensies. Wanneer dit wordt gebruikt, is de optie '-conn' vereist.
-connection -conn Vereist als de optie 'stream' wordt gebruikt. Naam van een opgeslagen verbinding die is gemaakt met de createlocalconnection CLI-opdracht.
-query -q Optioneel. Databasezoekvraag die samen met de streamingdimensieopbouw moet worden verstuurd.
-rows -rows Optioneel. Aantal tegelijk te streamen rijen. De standaardwaarde is 100.
-restructureOption -R

Hiermee kunt u kiezen wat u bij het herstructureren van de structuur wilt behouden.

Voor blokopslag zijn de volgende opties mogelijk:

  • ALL_DATA: bij het laden van dimensies alle gegevens behouden.
  • NO_DATA: geen gegevens behouden.
  • LEAFLEVEL_DATA: alleen gegevenswaarden van niveau 0 behouden. Als alle gegevens die voor de berekening zijn vereist, zich in onderdelen van niveau 0 bevinden, moet u deze optie selecteren. Alle blokken van de hogere niveaus worden verwijderd voordat de kubus wordt geherstructureerd. Wanneer de kubus opnieuw wordt berekend, worden de blokken op hogere niveaus opnieuw gemaakt.
  • INPUT_DATA: alleen ingevoerde gegevens behouden.

Voor geaggregeerde opslag zijn de volgende opties mogelijk:

  • ALL_DATA: bij het laden van dimensies alle gegevens behouden.
  • NO_DATA: geen gegevens behouden.
-forcedimbuild -F Doorgaan met opbouwen van de dimensie, ook als activiteiten van andere gebruikers worden uitgevoerd. Hierdoor worden actieve gebruikerssessies geannuleerd.

Voorbeelden

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

U kunt ook dimensies laden via Cube Designer, 'Taken' in de Essbase webinterface of REST-API, of dimensies importeren in MaxL.

Download: kubusbestanden ophalen

Met de CLI-opdracht download voor Essbase worden kubusartefacten vanuit een instance van Essbase gedownload naar een lokale directory.

Het kan nodig zijn tekstbestanden, regelbestanden of bestanden met berekeningsscripts uit een kubus te downloaden zodat u ermee kunt werken of ze naar een andere kubus kunt uploaden. Als u kubusartefacten wilt downloaden, hebt u ten minste het toegangsrecht 'Database bijwerken' nodig.

Syntaxis

download [-verbose] -file filename[ | -catalogfile catalogFile] [-application appname [-db cubename]] [-localdirectory path] [-overwrite] [-nocompression]
Optie Afkorting Beschrijving
-verbose -v Uitgebreide beschrijvingen tonen
-file -f Naam van het te downloaden bestand
-application -a Optioneel. Applicatienaam. Als niets wordt opgegeven, worden artefacten gedownload uit de basisdirectory van de gebruiker.
-db -d Optioneel. Naam database (kubus)
-catalogfile -CF Bestand in de bestandscatalogus. U kunt deze optie gebruiken in plaats van -file.
-localdirectory -ld Optioneel. Pad naar een lokale directory
-overwrite -o Optioneel. Bestaand bestand overschrijven
-nocompression -nc Optioneel. Compressie van gegevensoverdracht deactiveren

Voorbeelden

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

U kunt ook bestanden beheren in Cube Designer, de webinterface van Essbase of REST-API.

Help: syntaxis voor opdrachten weergeven

Met de CLI-opdracht help voor Essbase wordt hulp op opdrachtniveau getoond in de console of terminal.

Syntaxis

[command] -help | -h

Voorbeelden

esscs -help
esscs -h
esscs dataload -help

LcmExport: back-up maken van kubusbestanden

Met de CLI-opdracht lcmexport voor Essbase wordt een backup gemaakt van applicaties en kubusartefacten in een Lifecycle Management (LCM) .zip-bestand. Als u deze opdracht wilt uitvoeren, moet u minstens het recht 'Applicatiebeheer' hebben.

Syntaxis

lcmExport [-verbose] -application appname|-allApp -zipfilename filename [-localDirectory path][-threads threadscount][-skipdata][-overwrite][-generateartifactlist][-include-server-level][-cube][-exportdata][-filetype][-exportpartitions][-exportfilters][-restEncryPassword]
Optie Afkorting Beschrijving
-verbose -v Optioneel. Uitgebreide beschrijvingen tonen.
-application -a Naam van de applicatie waarvan een back-up moet worden gemaakt.
-allApp -aa Optioneel (en hoofdlettergevoelig). Als dit wordt gebruikt in plaats van -application, worden alle applicaties geëxporteerd in één zip-bestand. lcmimport kan single-application zip-bestanden of multiple-application zip-bestanden accepteren.
-zipfilename -z Optioneel. Naam van het gecomprimeerde bestand waarin back-upbestanden moeten worden bewaard.
-localdirectory -ld Optioneel. Pad naar een lokale directory. Indien niet opgegeven, wordt de zip opgeslagen in <Applicatiedirectory>/catalog/users/<user_name> op de Essbase server.
-threads -T Optioneel. Aantal op te starten threads bij gebruik van parallelle export. Minimum: 10
-skipdata -skip Optioneel. Geen gegevens in de back-up opnemen.
-overwrite -o Optioneel. Bestaand back-upbestand overschrijven.
-generateartifactlist -gal Optioneel. Hiermee wordt een tekstbestand gegenereerd dat een complete lijst met geëxporteerde artefacten bevat. U kunt dit tekstbestand gebruiken om het importeren van artefacten te beheren. Bijvoorbeeld: door de artefacten in de lijst opnieuw te rangschikken, kunt u de volgorde bepalen waarin ze worden geïmporteerd. U kunt het importeren van bepaalde artefacten overslaan door ze te verwijderen of uitcommentariëren.
-include-server-level -isl Optioneel. Neem algemeen gedefinieerde verbindingen en gegevensbronnen op.
-cube -c Optioneel. Eén kubus exporteren. Deze optie kan worden opgegeven samen met de opties om alleen het volgende te exporteren: gegevens, bestanden van een bepaald soort, partities of filters.
-exportdata -d Optioneel. Alleen gegevens exporteren
-filetype -ft

Optioneel. Alleen bestanden van het opgegeven type exporteren. Ondersteunde bestandstypen zijn OTL (outline), TXT (text), RUL (rule), CSC (calc script), DTR (drill through report definition) en Excel (alleen .xls-bestanden worden geëxporteerd. .xlsx-bestanden worden niet geëxporteerd).

Voorbeelden:

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

Optioneel. Alleen partitiedefinities exporteren.

Importbewerkingen van Lifecycle Management (LCM) (en import van het hulpprogramma voor migratie) worden niet ondersteund voor migratie van federatieve partities. Federatieve partities moeten handmatig opnieuw worden gemaakt op het doel.
-exportfilters -ef Optioneel. Alleen beveiligingsfilters exporteren.
-restEncryPassword -encryPwd

Als de applicatie wordt versleuteld, is er een wachtwoord nodig om de versleutelde applicatie tijdens migratie te beschermen. Het wachtwoord moet 6-15 tekens lang zijn en mag de volgende tekens niet bevatten: ?=.,*!@#&()[{}]:;'/~$^+<>-.

Let op: als dit wachtwoord wordt vergeten, valt het niet te herstellen en kan de applicatie niet worden geïmporteerd.

Notities

Net als andere CLI-opdrachten kan deze opdracht buiten de Essbase machine worden gebruikt, terwijl het hulpprogramma LCM op de Essbase machine moet worden uitgevoerd.

Voorbeeld

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

Voorbeeld van Windows-script

Met het volgende Windows-script, lcmexportall.bat, worden alle applicaties geëxporteerd naar de huidige lokale directory vanuit waar CLI is aangeroepen.

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: kubusbestanden herstellen

Met de CLI-opdracht lcmimport voor Essbase worden kubusartefacten hersteld vanuit een Lifecycle Management (LCM) .zip-bestand. Als u deze opdracht wilt uitvoeren, moet u de hoofdgebruiker zijn die de applicatie heeft gemaakt, of een servicebeheerder.

Syntaxis

lcmImport [-verbose] -zipfilename filename [-overwrite] [-targetappName targetApplicationName][-include-server-level][-artifactlist artifactList][-restEncryPassword]
Optie Afkorting Beschrijving
-verbose -v Optioneel. Uitgebreide beschrijvingen tonen
-zipfilename -z Naam van het gecomprimeerde bestand dat back-upbestanden bevat
-overwrite -o Optioneel. Hiermee wordt de doelapplicatie opnieuw gemaakt.
-targetappName -ta Optioneel. Naam van de doelapplicatie als u wilt dat die afwijkt van de bronnaam.
-artifactlist -al Optioneel. Naam van het bestand met de lijst van te importeren artefacten. Het bestand kan worden gegenereerd via lcmexport.

Als u artefacten wilt overslaan, commentarieert u lijstitems uit of verwijdert u deze. Bijvoorbeeld: als u het importeren van controlerecords wilt overslaan, commentarieert u die regel uit zoals hier is weergegeven:

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

Als u de importvolgorde wilt bepalen, rangschikt u de importgegevens in het tekstbestand opnieuw.

Als u '–overwrite' gebruikt, wordt de gehele applicatie verwijderd en opnieuw gemaakt en worden alleen de artefacten geïmporteerd die voorkomen in de lijst. Als u '–overwrite' niet gebruikt, worden alle artefacten geïmporteerd die voorkomen in de lijst, zonder dat dit van invloed is op andere artefacten die al in de doelapplicatie aanwezig zijn.
-include-server-level -isl Optioneel. Neem algemeen gedefinieerde verbindingen en gegevensbronnen op.
-restEncryPassword -encryPwd

Als de applicatie wordt versleuteld, is er een wachtwoord nodig om de versleutelde applicatie tijdens migratie te beschermen. Het wachtwoord moet 6-15 tekens lang zijn en mag de volgende tekens niet bevatten: ?=.,*!@#&()[{}]:;'/~$^+<>-.

Let op: als dit wachtwoord wordt vergeten, valt het niet te herstellen en kan de applicatie niet worden geïmporteerd.

Notities

  • Net als andere CLI-opdrachten kan deze opdracht buiten de Essbase machine worden gebruikt, terwijl het hulpprogramma LCM binnen de Essbase machine moet worden uitgevoerd.

  • Nadat de LCM-import is voltooid, moet u mogelijk meer actie ondernemen om gemigreerde verbindingen met externe bronnen te herstellen. Open hiervoor de verbinding en voer het wachtwoord in.

  • Als er partities aanwezig zijn tussen kubussen die worden gemigreerd, moet u de gegevensbron importeren voordat de doelbron wordt geïmporteerd. Als u dat niet doet, kunnen partitiedefinities mogelijk niet worden hersteld.

    Importbewerkingen van Lifecycle Management (LCM) (en import van het hulpprogramma voor migratie) worden niet ondersteund voor migratie van federatieve partities. Federatieve partities moeten handmatig opnieuw worden gemaakt op het doel.

  • Met 'LCM importeren' worden de referenties voor een locatie-alias niet gemigreerd. U moet de referenties voor de locatie-alias vervangen. Dit kan door de locatie-alias opnieuw te maken met behulp van MaxL of door de referenties voor de locatie-alias te bewerken in de XML die is geëxporteerd met 'LCM importeren'.

Voorbeeld

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

Listapp: applicaties weergeven

Met de CLI-opdracht listapp wordt een lijst getoond met applicaties waartoe u toegang hebt op deze instance van Essbase.

Syntaxis

listapp [-verbose] [-details]
Optie Afkorting Beschrijving
-verbose -v Optioneel. Uitgebreide beschrijvingen tonen
-details -dtl Optioneel. Meer details weergeven in de uitvoer (applicatietype en huidige status)

Voorbeeld

esscs listapp -v -dtl

Listdb: kubussen weergeven

Met de CLI-opdracht listdb wordt een lijst getoond met databases waartoe u toegang hebt binnen een opgegeven Essbase applicatie.

Syntaxis

listdb [-verbose] -application applicationName [details]
Optie Afkorting Beschrijving
-verbose -v Optioneel. Uitgebreide beschrijvingen tonen
-application -a Applicatienaam
-details -dtl Optioneel. Statusdetails weergeven in de uitvoer

Voorbeeld

esscs listdb -v -a Sample -dtl

Listfiles: bestanden weergeven

Met de CLI-opdracht listfiles worden kubusartefacten weergegeven die voorkomen in een instance van Essbase.

Kubusartefacten kunnen bestaan uit gegevensbestanden, werkboeken, regelbestanden, bestanden met berekeningsscripts of andere artefacten. Kubusartefacten kunnen ook bestanden zijn die nodig zijn voor het uitvoeren van acties op applicaties en kubussen.

Als u de bestanden voor een kubus wilt weergeven, moet u minstens het recht 'Databasetoegang' hebben voor de applicatie. Er zijn geen speciale rechten vereist om een lijst op te vragen van de bestanden in uw gebruikersdirectory.

Syntaxis

listfiles [-verbose] [-type filetype] [-application appname [-db cubename] | -catalogpath catalogPath]
Optie Afkorting Beschrijving
-verbose -v Optioneel. Uitgebreide beschrijvingen tonen
-type -t Optioneel. Weer te geven bestandsextensie/-type, exclusief de punt

Ondersteunde bestandstypen zijn:

  • .csc (berekeningsscripts)
  • .rul (regelbestanden)
  • .txt (tekstbestanden)
  • .msh (MaxL-scripts)
  • .xls, .xlsx (Excel-werkboeken)
  • .xlsm (Excel-werkboeken met macro's)
  • .xml (XML-bestanden)
  • .zip (gecomprimeerde zip-bestanden)
  • .csv (door komma's gescheiden bestanden)
-application -a Optioneel. Applicatienaam. Als niets wordt opgegeven, worden bestanden uit uw gebruikersdirectory weergegeven.
-db -d Optioneel. Naam database (kubus)
-catalogpath -CP Optioneel. Cataloguspad naar de bestandsnaam. Kan worden gebruikt in plaats van -a [-d] om de cataloguslocatie van het bestand/de bestanden op te geven.

Voorbeelden

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

U kunt ook bestanden beheren in Cube Designer, de webinterface van Essbase of REST-API.

Listfilters: beveiligingsfilters bekijken

Met de CLI-opdracht listfilters wordt een lijst weergegeven met Essbase beveiligingsfilters. U hebt ten minste het recht 'Databasebeheer' nodig voor de applicatie om filters voor kubussen in de applicatie te kunnen zien.

Syntaxis

listfilters [-verbose] -application appname -db cubename
Optie Afkorting Beschrijving
-verbose -v Optioneel. Uitgebreide beschrijvingen tonen
-application -a Applicatienaam
-db -d Naam database (kubus)

Voorbeeld

esscs listfilters -v -a Sample -d Basic

Listlocks: vergrendelingen bekijken

Met de CLI-opdracht listlocks voor Essbase worden vergrendelde gegevensblokken of kubusgerelateerde objecten getoond. Als u deze opdracht wilt uitvoeren, hebt u ten minste het recht 'Databasetoegang' nodig voor de applicatie.

Syntaxis

listlocks [-verbose] -application appname -db cubename [-object]
Optie Afkorting Beschrijving
-verbose -v Optioneel. Uitgebreide beschrijvingen tonen
-application -a Applicatienaam
-db -d Naam database (kubus)
-object -obj Optioneel. Vergrendelde bestanden/artefacten weergeven

Voorbeeld

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

Listvariables: vervangingsvariabelen weergeven

Met de CLI-opdracht listvariables voor Essbase worden vervangingsvariabelen getoond die zijn gedefinieerd in het kubus-, applicatie- of algemene bereik. U hebt ten minste het toegangsrecht 'Databasetoegang' nodig als u variabelen voor een kubus wilt kunnen zien, de rol 'Applicatiebeheer' als u variabelen voor een applicatie wilt kunnen zien en de rol 'Servicebeheerder' als u algemene variabelen wilt kunnen zien.

Syntaxis

listvariables [-verbose] [-application application [-db database]]
Optie Afkorting Beschrijving
-verbose -v Uitgebreide beschrijvingen tonen.
-application -a Optioneel. Applicatienaam.
-database -db Optioneel. Naam database (kubus).

Voorbeelden

Kubusniveau

esscs listvariables -a Sample -db Basic

Applicatieniveau

esscs listvariables -a Sample

Algemeen niveau

esscs listvariables

Setpassword: CLI-referenties opslaan

Met de CLI-opdracht setpassword voor Essbase wordt een wachtwoord opgeslagen dat is gekoppeld aan uw combinatie van client en gebruiker. In volgende sessies kunt u inloggen zonder een wachtwoord in te voeren.

Syntaxis

 setpassword [-verbose] -essbaseurl URL -user userName
Optie Afkorting Beschrijving
-verbose -v Optioneel. Uitgebreide beschrijvingen tonen
-essbaseurl -url Adres van een instance van Essbase
-user -u Uw gebruikersnaam

Notities

Na migratie naar versie 21.4 of hoger moet u wachtwoorden opnieuw instellen die met dit commando zijn opgeslagen in een vorige versie.

Voorbeeld

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

Start: een applicatie of kubus starten

Met de CLI-opdracht start wordt een applicatie of kubus van Essbase gestart door deze in het geheugen te laden. Als u deze opdracht wilt uitvoeren, hebt u ten minste het recht 'Databasetoegang' nodig voor de applicatie.

Syntaxis

start [-verbose] -application appname [-db cubename]
Optie Afkorting Beschrijving
-verbose -v Optioneel. Uitgebreide beschrijvingen tonen
-application -a Applicatienaam
-db -d Optioneel. Naam database (kubus)

Voorbeeld

esscs start -v -a Sample -d Basic

Stop: een applicatie of kubus stoppen

Met de CLI-opdracht stop wordt een Essbase applicatie of kubus gestopt. Als u deze opdracht wilt uitvoeren, hebt u ten minste het recht 'Databasetoegang' nodig voor de applicatie.

Syntaxis

stop [-verbose] -application appname [-db cubename]
Optie Afkorting Beschrijving
-verbose -v Optioneel. Uitgebreide beschrijvingen tonen
-application -a Applicatienaam
-db -d Optioneel. Naam database (kubus)

Voorbeeld

esscs stop -v -a Sample -d Basic

Unsetpassword: opgeslagen CLI-referenties verwijderen

Met de CLI-opdracht unsetpassword voor Essbase worden de opgeslagen inlogreferenties verwijderd die zijn gekoppeld aan uw combinatie van client en gebruiker, en wordt het effect van setpassword ongedaan gemaakt.

Syntaxis

unsetpassword [-verbose] -essbaseurl URL -user userName
Optie Afkorting Beschrijving
-verbose -v Uitgebreide beschrijvingen tonen
-essbaseurl -url Adres van een instance van Essbase
-user -u De gebruiker van wie het wachtwoord moet worden verwijderd

Voorbeeld

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

Upload: kubusbestanden toevoegen

Met de CLI-opdracht upload worden kubusartefacten vanuit een lokale directory geladen in een instance van Essbase.

Als u taken wilt uitvoeren zoals het laden van gegevens, het opbouwen van dimensies of het uitvoeren van berekeningen of andere bewerkingen, moet u mogelijk gegevensbestanden, regelbestanden, bestanden met berekeningsscripts of andere artefacten uploaden naar de kubusdirectory. U kunt de artefacten ook uploaden naar uw gebruikersdirectory.

Als u bestanden wilt uploaden naar een kubus, hebt u ten minste het toegangsrecht 'Databasebeheer' nodig. Er zijn geen speciale rechten vereist om te uploaden naar uw gebruikersdirectory.

Opmerking:

U kunt antivirusscans activeren in de Essbase webinterface zodat bestanden worden gescand op virussen voordat ze naar de server worden geladen.

Syntaxis

upload [-verbose] -file filename [-application appname [-db cubename] | -catalogpath catalogPath] [-overwrite] [-nocompression][-compressionalgorithm]
Optie Afkorting Beschrijving
-verbose -v Optioneel. Uitgebreide beschrijvingen tonen
-file -f Naam van het te uploaden bestand

Opmerking:

Bestandsextensies mogen alleen kleine letters bevatten. Bijvoorbeeld bestandsnaam.txt.
-application -a Optioneel. Applicatienaam. Als deze niet is opgegeven, worden de bestanden in uw gebruikersdirectory geladen of naar het cataloguspad dat is opgegeven in -CP.
-db -d Optioneel. Naam database (kubus). Hiervoor is -a vereist.
-catalogpath -CP Optioneel. Cataloguspad naar de bestandsnaam. Kan worden gebruikt in plaats van -a [-d] om de cataloguslocatie van het bestand op te geven.
-overwrite -o Optioneel. Bestaand bestand overschrijven
-nocompression -nc Optioneel. Compressie van gegevensoverdracht deactiveren
-compressionalgorithm -ca Optioneel. Beschikbaar als -nc niet wordt gebruikt. Hiermee wordt het gewenste compressiealgoritme voor de gegevensoverdracht gedefinieerd. Keuzemogelijkheden: gzip of lz4.

  • 'gzip' is de standaardwaarde wanneer compressie wordt gebruikt. Kenmerken van gzip: kleinere gegevensoverdracht en langzamere berekening.

  • Kenmerken van lz4: snellere berekening en langzamere gegevensoverdracht.

Gebruiksvoorbeelden:

-ca gzip
-ca lz4

Voorbeelden

esscs upload -v -f c:/temp/Maxl01.msh -a Sample -d Basic -o -ca lz4
esscs upload -f C:/temp/Act1.rul -CP /shared

U kunt ook bestanden beheren in Cube Designer, de webinterface van Essbase of REST-API.

Version: API-versie weergeven

Met de CLI-opdracht version wordt de versie opgehaald van de REST-API die aan deze instance van Essbase is gekoppeld.

Syntaxis

version

Voorbeeld

esscs version