CLI-komentoviite

Essbase CLI -komennot, jotka annat esscs-komentotulkissa, auttavat suorittamaan rutiininomaisia alustatoimintoja, kuten: laskenta, tietojen lataus, dimension luonti, lcm-vienti, lcm-tuonti, sisältöjen tuonti ja vienti, sovelluksen tai kuution käynnistys ja pysäytys, ja paljon muuta.

Seuraavat komennot ovat käytettävissä komentoriviliittymässä. Komentojen argumentit voi esittää vapaassa järjestyksessä.

Saat kaikkien komentojen ohjeen näkyviin syöttämällä esscs -h. Jos haluat katsoa jonkin tietyn komennon ohjetta, syötä esscs command -h.

Jos haluat ottaa käyttöön jonkin komennon sanallisen tulostuksen, jossa näytetään laajennetut tiedot (jos ne ovat käytettävissä), syötä esscs command -v command arguments.

Sisään/ulos kirjautuminen: CLI-todennus

Essbasen CLI-komento login todentaa sinut Essbasessa, jotta voit käyttää komentoliittymää.

Ennen kuin voit antaa mitään muita CLI-komentoja Essbase-palvelussa, sinun on kirjauduttava sisään. Jos vaaditaan suojattua yhteyttä URL-osoitteen nimen alussa on oltava https.

Voit kirjautua seuraavin tavoin CLI-komennoilla:

  • Käytä setpassword-komentoa kerran tallentaaksesi työasema-/käyttäjäyhdistelmäsi salasanan. Tämän jälkeen voit kirjautua login-komennolla ilman, että sinulta pyydetään salasanaa.
  • Käytä -user- ja -password-argumentteja login-komennon kanssa (huom. salasana näkyy komentotulkki-ikkunassa cleartext-muodossa).
  • Käytä vain -user-argumenttia login-komennon kanssa. Sinua pyydetään antamaan salasana, joka piilotetaan.

Jos olet yhdistetyn kertasisäänkirjauksen käyttäjä Oracle Identity Cloud Service -palvelussa, sisäänkirjausta MaxL:n tai CLI:n avulla ei tueta. Yhdistetty kertasisäänkirjaus vaatii selainikkunan. Luo alkuperäinen Identity Cloud Service -käyttäjä ja käytä sitä, kun kirjaudut sisään MaxL:n tai CLI:n kautta.

Syntaksi (sisäänkirjaus)

login [-verbose] -essbaseurl https://instance-name.example.com/essbase -user username [-password password]
Valinta Lyhenne Kuvaus
-verbose -v Näytä laajennetut kuvaukset.
-essbaseurl -url Essbase-instanssin osoite
-user -u Käyttäjätunnus
-password -p Valinnainen. Käyttäjän salasana. Voit myös määrittää salasanan komentoa setpassword käyttämällä.

Jos login-komento annetaan komentosarjasta ja salasana sisältää erikoismerkkejä, ympäröi se lainausmerkeillä (esimerkiksi "aNb3^5%9$!").

Merkin $ (dollarisymboli) käyttöä Essbase-salasanassa ei tueta kirjautumisessa Linux-ympäristöön.

Esimerkki 1 (sisäänkirjaus)

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

Esimerkki 2 (sisäänkirjaus)

Seuraavassa esimerkissä sisään kirjautuva käyttäjä admin1@example.com on Identity Cloud Service -pääkäyttäjä, joka oli määritetty alkuperäiseksi Essbase-pääkäyttäjäksi, kun Essbase-pino otettiin käyttöön Oracle Cloud Infrastructure -ympäristössä. Koska salasanaa ei syötetä tässä esimerkissä, pääkäyttäjää pyydetään antamaan se seuraavaksi. URL-osoite on essbase_url-arvo, joka on peräisin pinon käyttöönoton työn tulosteista.

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

Syntaksi (uloskirjaus)

logout

Esimerkki (uloskirjaus)

esscs logout

Calc: laskentakomentosarjan suoritus

Essbasen CLI-komento calc suorittaa laskentakomentosarjan kuutiossa. Komennon suoritukseen tarvitaan vähintään tietokannan päivitysoikeus sekä laskentakomentosarjan tarjotut käyttöoikeudet.

Laskentakomentosarjojen suoritusta varten on ensin ladattava komentosarjat .csc-tiedostoina kuution hakemistoon. Voit ladata tiedostot CLI-liittymän avulla. Katso kohta Upload: kuutiotiedostojen lisäys.

Syntaksi

calc [-verbose] -application appname -db cubename -script scriptfilename
Valinta Lyhenne Kuvaus
-verbose -v Näytä laajennetut kuvaukset.
-application -a Sovelluksen nimi.
-db -d Tietokannan (kuution) nimi.
-script -s Laskentakomentosarjan nimi. Nimessä on oltava .csc-tiedostotunniste. Koko polkua ei tarvitse antaa. Tiedostojen oletetaan olevan asiaankuuluvassa kuutiohakemistossa.

Esimerkki

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

Voit suorittaa laskentakomentosarjoja myös Cube Designer -ohjelman Laske-valinnalla, Smart View -sovelluksessa, Essbase-web-käyttöliittymässä, REST API -liittymän kautta tai MaxL:n execute calculation -komennolla.

Clear: tietojen poisto kuutiosta

Essbasen CLI-komento clear tyhjentää kuution tiedot. Komennon käyttö edellyttää vähintään tietokannan päivitysoikeutta.

Syntaksi

clear [-verbose] -application appname -db cubename [-option clearOption[-regionspec regionSpec]]
Valinta Lyhenne Kuvaus
-verbose -v Valinnainen. Näytä laajennetut kuvaukset.
-application -a Sovelluksen nimi.
-db -d Tietokannan (kuution) nimi.
-option -O Valinnainen. Avainsana, jolla määritetään, mitä tyhjennetään. Oletusvalinta tyhjälle arvolle on ALL_DATA.

Lohkotallennuskuutioiden valinnat:

  • ALL_DATA — kaikki tiedot, linkitetyt objektit ja runko tyhjennetään

  • UPPER_LEVEL— ylemmän tason lohkot tyhjennetään

  • NON_INPUT— lohkot, joissa ei ole syötteitä, tyhjennetään

Koostetallennuskuutioiden valinnat:

  • ALL_DATA — kaikki tiedot, linkitetyt objektit ja runko tyhjennetään

  • ALL_AGGREGATIONS

    — kaikki koostetiedot tyhjennetään

  • PARTIAL_DATA

    — vain määritetty tietoalue tyhjennetään Käytä -regionspec-valinnan kanssa.
-regionspec -rs Tyhjennettävän alueen määrittävä MDX-lause

Esimerkki

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

Voit tyhjentää tietoja myös käyttämällä Cube Designer -ohjelman Lataa tiedot -valintaa, Essbase-web-käyttöliittymän Työt-valintaa, REST API -liittymää tai MaxL:n alter database DBS-NAME reset -komentoa.

Createlocalconnection: JDBC-yhteyden tallennus

Essbasen CLI-komento createlocalconnection luo JDBC-yhteyden ja tallentaa sen paikallisesti. Komennon käyttö edellyttää palvelun järjestelmänvalvojan tai tehokäyttäjän roolia.

Kuvaus

Palvelun järjestelmänvalvojan on luotava ja tallennettava paikallinen yhteys tällä komennolla ennen kuin kukaan voi käyttää CLI-komentoa dataload tai dimbuild tietovirtavalinnan kanssa. Määritä myös ympäristömuuttuja EXTERNAL_CLASSPATH osoittamaan tietokanta-ajurin .jar-tiedostoon (ks. Dimensioiden muodostus ja tietojen lataus tietovirran avulla etätietokannasta).

Syntaksi

createLocalConnection [-verbose] -name streamConnection -connectionstring  connectionString -user userName [-driver jdbcDriver] [-password password]
Valinta Lyhenne Kuvaus
-verbose -v Näytä laajennetut kuvaukset.
-name -N Yhteyden nimi
-connectionstring -cs JDBC-yhteysmerkkijono. Muotoon voi sisältyä palvelun nimi, kuten tässä esimerkissä: 
jdbc:oracle:thin:@host:port/service_name

tai SID, kuten tässä esimerkissä:

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

Edellä mainitut syntaksimuodot koskevat Oracle-tietokantaa. Esimerkit-osassa voit tarkastella yhteysmerkkijonon syntaksissa esiintyviä pieniä eroja käytettäessä muita palveluntarjoajia.
-user -u Käyttäjätunnus
-driver -D JDBC-ajuri. Jos ajuria ei anneta, oletusarvona pidetään Oracle-tietokantaa muodossa oracle.jdbc.driver.OracleDriver
-password -p Salasana (valinnainen)

Jos ulkoisen tietolähteen ja Essbasen välillä on verkkoyhteys, on tehokkainta määrittää sovellustason yhteyksiä, yleisiä yhteyksiä ja tietolähteitä Essbase-web-käyttöliittymässä. Näiden määritysten avulla voit hakea tietoja helposti ulkoisesta lähteestä. Jos ulkoisen tietolähteen ja Essbasen välillä ei ole verkkoyhteyttä, voit suorittaa tietojen lataukset ja dimensioiden muodostukset tietovirtoina CLI:n avulla. Voit tehdä tämän luomalla ensin paikallisen yhteyden käyttämällä tätä komentoa ja suorittamalla sitten dataload- tai dimbuild-komennon stream-valinnalla.

Huomautuksia

Versioon 21.4 tai uudempaan siirtymisen jälkeen palvelun pääkäyttäjän on luotava uudelleen mahdolliset paikalliset yhteydet, jotka luotiin tällä komennolla edellisessä versiossa.

Esimerkkejä

Jos-driver-valintaa ja jdbcDriver-parametria ei anneta, Oracle-tietokantaa käytetään oletustietokantana.

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

Jos-driver-valintaa ja jdbcDriver-parametria ei anneta, Oracle-tietokantaa käytetään oletustietokantana.

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

Jos-driver-valintaa ja jdbcDriver-parametria ei anneta, Oracle-tietokantaa käytetään oletustietokantana.

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

Jos-driver-valintaa ja jdbcDriver-parametria ei anneta, Oracle-tietokantaa käytetään oletustietokantana.

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

Jos-driver-valintaa ja jdbcDriver-parametria ei anneta, Oracle-tietokantaa käytetään oletustietokantana.

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

Jos-driver-valintaa ja jdbcDriver-parametria ei anneta, Oracle-tietokantaa käytetään oletustietokantana.

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

Dataload: tietojen lataus kuutioon

Essbasen CLI-komento dataload lataa tiedot kuutioon. Komennon käyttö edellyttää vähintään tietokannan päivitysoikeutta.

Tämä komento vaatii jonkin seuraavista valintajoukoista:

  • Datatiedosto ja valinnainen sääntötiedosto

  • Sääntötiedosto, käyttäjätunnus ja salasana

  • Tallennettuun paikalliseen yhteyteen viittaava tietovirtavalinta

Lähdetietokannan pitäisi olla käytettävissä työaseman verkossa, koska kaikki tietokantaohjaimet eivät toimi Java-välipalvelinten kanssa.

Tietojen lataamista varten tietojen lataus- ja sääntötiedostot on ensin ladattava kuutiohakemistoon. Voit ladata tiedostot CLI-liittymän avulla. Katso kohta Upload: kuutiotiedostojen lisäys.

Syntaksi

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]
Valinta Lyhenne Kuvaus
-verbose -v Näytä laajennetut kuvaukset.
-application -a Sovelluksen nimi.
-db -d Tietokannan (kuution) nimi.
-file -f Tietojen lataustiedoston nimi Koko polkua ei tarvitse antaa. Tiedostojen oletetaan olevan asiaankuuluvassa tietokantahakemistossa. Voit käyttää -catalogfile-valintaa tämän valinnan sijaan.
-rule -r Valinnainen. Sääntötiedoston nimi. Koko polkua ei tarvitse antaa. Tiedostojen oletetaan olevan asiaankuuluvassa tietokantahakemistossa. Voit käyttää -catalogrulefile-valintaa tämän valinnan sijaan.
-catalogfile -CF Tietojen latauksen tiedoston nimi tiedostoluettelosta. Voit käyttää tätä valintaa -file-valinnan sijaan.
-catalogrulefile -CRF Sääntötiedoston nimi tiedostoluettelosta. Voit käyttää tätä valintaa -rule-valinnan sijaan.
-user -u Valinnainen. Käyttäjätunnus. Edellyttää salasanaa käytettäessä.

Jos käytät tallennettua yhteyttä ja tietolähdettä, käyttäjätunnusta ja salasanaa ei tarvita. Jos et käytä tallennettua yhteyttä ja sääntötiedosto muodostaa yhteyden RDBMS-järjestelmään, määritä käyttäjätunnus ja salasana, joilla luodaan yhteys RDBMS-järjestelmään.
-password -p Valinnainen. Käyttäjän salasana. Jos tämä jätetään pois, käyttäjältä kysytään salasanaa.
-stream -S Valinnainen. Käytä tietovirran tietojen latausta. Edellyttää -conn-valintaa käytettäessä.
-connection -conn Pakollinen, jos tietovirtavalinta on käytössä. createlocalconnection CLI -komennolla luodun tallennetun yhteyden nimi.
-query -q Valinnainen. Tietokantakysely, joka lähetetään yhdessä tietojen latauksen tietovirran kanssa.
-rows -rows Valinnainen. Tietovirran samanaikaisten rivien määrä. Oletus on 100.
-abortOnError -abort Keskeytä tietojen lataus virheen ilmetessä

Esimerkkejä

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"

Voit ladata tietoja myös käyttämällä Cube Designer -ohjelmaa, Essbase-web-liittymän Työt-valintaa tai REST API -liittymää tai MaxL:n import data -komentoa.

Deletefile: kuutiotiedostojen poisto

Essbasen CLI-komento deletefile poistaa kuution sisällöt sovelluksesta, tietokannasta tai käyttäjän kotihakemistosta. Sinulla on oltava kuutiossa ainakin tietokannan pääkäyttäjän oikeudet, jotta voit poistaa kuutiosta vanhoja tiedostoja. Tiedostojen poistamiseen käyttäjähakemistosta ei tarvita erikoisoikeuksia.

Syntaksi

deletefile [-verbose] -file fileName [-application application [-db  database] [| -catalogfile catalogFile]]
Valinta Lyhenne Kuvaus
-verbose -v Näytä laajennetut kuvaukset.
-file -f Poistettavan tiedoston nimi
-application -a Valinnainen. Sovelluksen nimi. Jos tätä arvoa ei määritetä, tiedostojen oletetaan olevan käyttäjän kotihakemistossa.
-database -db Valinnainen. Tietokannan (kuution) nimi.
-catalogfile -CF Tiedoston polku ja nimi tiedostoluettelosta. Voit käyttää tätä valintaa -file-valinnan sijaan.

Esimerkkejä

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

Voit hallita tiedostoja myös Cube Designer -ohjelmassa, Essbase-web-käyttöliittymässä tai REST API -liittymän kautta.

Deploy: kuution luonti työkirjasta

Essbasen CLI-komento deploy luo kuution Excel-sovellustyökirjasta. Tarvitset vähintään tehokäyttäjän oikeudet, jotta voit suorittaa tämän komennon.

Syntaksi

deploy [-verbose] -file fileName [-application application [-database database] | -catalogfile catalogFile] [-restructureoption restructureOption] [-loaddata] [-recreateapplication] [-createfiles] [-executescript]
Valinta Lyhenne Kuvaus
-verbose -v Näytä laajennetut kuvaukset.
-file -f Sovelluksen työkirjan tiedoston nimi
-application -a Valinnainen. Sovelluksen nimi. Jos sovellukselle ei ole annettu nimeä, nimi otetaan työkirjasta.
-database -db Valinnainen. Tietokannan (kuution) nimi. Jos tietokannalle ei ole annettu nimeä, nimi otetaan työkirjasta.
-catalogfile -CF Tiedostoluettelossa oleva sovelluksen työkirja. Voit käyttää tätä valintaa -file-valinnan sijaan.
-loaddata -l Valinnainen. Lataa tiedot, jos sovelluksen työkirja sisältää tietotyöarkin. Muutoin kuutioon tuodaan vain metatiedot.
-restructureOption -R Valinnainen. Haluttua rakenteen muutosvalintaa ilmaiseva avainsana.

Lohkotallennuskuutioiden valinnat:

  • ALL_DATA—Säilytä kaikki tiedot

  • NO_DATA—Älä säilytä mitään tietoja

  • LEAFLEVEL_DATA—Säilytä 0-tason (lehtitason) tiedot

  • INPUT_DATA—Säilytä syöttötiedot

Koostetallennuskuutioiden valinnat:

  • ALL_DATA—Säilytä kaikki tiedot

  • NO_DATA—Älä säilytä mitään tietoja
-recreateapplication -ra Valinnainen. Luo sovellus uudelleen, jos se on jo olemassa
-createfiles -cf Valinnainen. Luo kuutioartefaktit Essbasen tiedostohakemistoon.
-executescript -e Valinnainen. Suorita laskutoimituksen komentosarjat. Sovellettavissa vain, jos sovelluksen työkirja sisältää laskennan työarkin, jossa määrityksissä Suorita laskenta-arvo on Kyllä.

Esimerkkejä

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

Voit myös ottaa kuutioita käyttöön käyttämällä Cube Designer -ohjelmaa tai Essbase-web-käyttöliittymän Sovellukset-osassa olevaa Tuo-valintaa.

Dimbuild: Dimensioiden lataus kuutioon

Essbasen CLI-komento dimbuild lataa dimensiot kuutioon. Tarvitset kuutioon vähintään tietokannan järjestelmänvalvojan oikeudet, jotta voit suorittaa komennon.

Ennen kuin voit ladata dimensioita, sinun on ensin ladattava dimension muodostus- ja sääntötiedostot Essbaseen. Voit ladata tiedostot CLI-liittymän avulla. Katso kohta Upload: kuutiotiedostojen lisäys.

Syntaksi

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]
Valinta Lyhenne Kuvaus
-verbose -v Näytä laajennetut kuvaukset.
-application -a Sovelluksen nimi.
-db -d Tietokannan (kuution) nimi.
-file -f Dimensionmuodostustiedoston nimi. Koko polkua ei tarvitse antaa. Tiedostojen oletetaan olevan asiaankuuluvassa sovelluksessa tai tietokantahakemistossa. Voit käyttää -catalogfile-valintaa tämän valinnan sijaan.
-rule -r Sääntötiedoston nimi. Koko polkua ei tarvitse antaa. Tiedostojen oletetaan olevan asiaankuuluvassa sovelluksessa tai tietokantahakemistossa. Voit käyttää -catalogrulefile-valintaa tämän valinnan sijaan.
-catalogfile -CF Dimension muodostustiedoston nimi tiedostoluettelosta. Voit käyttää tätä valintaa -file-valinnan sijaan.
-catalogrulefile -CRF Sääntötiedoston nimi tiedostoluettelosta. Voit käyttää tätä valintaa -rule-valinnan sijaan.
-user -u Valinnainen. Käyttäjätunnus. Edellyttää salasanaa käytettäessä.

Jos käytät tallennettua yhteyttä ja tietolähdettä, käyttäjätunnusta ja salasanaa ei tarvita. Jos et käytä tallennettua yhteyttä ja sääntötiedosto muodostaa yhteyden RDBMS-järjestelmään, määritä käyttäjätunnus ja salasana, joilla luodaan yhteys RDBMS-järjestelmään.
-password -p Valinnainen. Käyttäjän salasana. Jos tämä jätetään pois, käyttäjältä kysytään salasanaa.
-stream -S Valinnainen. Muodosta dimensio tietovirtatilassa. Edellyttää -conn-valintaa käytettäessä.
-connection -conn Pakollinen, jos tietovirtavalinta on käytössä. createlocalconnection CLI -komennolla luodun tallennetun yhteyden nimi.
-query -q Valinnainen. Tietokantakysely, joka lähetetään yhdessä dimensionmuodostuksen tietovirran kanssa.
-rows -rows Valinnainen. Tietovirran samanaikaisten rivien määrä. Oletus on 100.
-restructureOption -R

Säätää rungon uudelleenmääritystä koskevia säilytysvalintojasi.

Lohkotallennuksen valinnat ovat seuraavat:

  • ALL_DATA: Säilytä kaikki tiedot dimensioita ladattaessa.
  • NO_DATA: Älä säilytä tietoja.
  • LEAFLEVEL_DATA: Säilytä vain nollatason tietoarvot. Jos kaikki laskennassa tarvittavat tiedot sijaitsevat 0-tason jäsenissä, valitse tämä valinta. Kaikki ylemmän tason lohkot poistetaan ennen kuution uudelleenmääritystä. Kun kuutio on laskettu uudelleen, ylemmän tason lohkot luodaan uudestaan.
  • INPUT_DATA: Säilytä vain syöttötiedot.

Koostetallennuksen valinnat ovat seuraavat:

  • ALL_DATA: Säilytä kaikki tiedot dimensioita ladattaessa.
  • NO_DATA: Älä säilytä tietoja.
-forcedimbuild -F Jatka dimension muodostamista, vaikka muita käyttäjän toimintoja olisikin käynnissä. Tämä peruuttaa aktiiviset käyttäjän istunnot.

Esimerkkejä

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

Voit ladata dimensioita myös käyttämällä Cube Designer -ohjelmaa, Essbase-web-liittymän Työt-valintaa tai REST API -liittymää tai MaxL:n import dimensions -komentoa.

Download: kuutiotiedostojen haku

CLI-komento download noutaa Essbase-kuutiosisällöt Essbase-instanssista paikalliseen hakemistoon.

Joudut ehkä noutamaan tekstitiedostoja, sääntötiedostoja tai laskentakomentosarjatiedostoja kuutiosta, jotta voit käsitellä niitä tai ladata ne toiseen kuutioon. Kuutioartefaktin nouto edellyttää vähintään tietokannan päivitysoikeutta.

Syntaksi

download [-verbose] -file filename[ | -catalogfile catalogFile] [-application appname [-db cubename]] [-localdirectory path] [-overwrite] [-nocompression]
Valinta Lyhenne Kuvaus
-verbose -v Näytä laajennetut kuvaukset.
-file -f Noudettavan tiedoston nimi.
-application -a Valinnainen. Sovelluksen nimi. Jos tätä arvoa ei määritetä, artefaktit noudetaan käyttäjän kotihakemistosta.
-db -d Valinnainen. Tietokannan (kuution) nimi.
-catalogfile -CF Tiedostoluettelon tiedosto. Voit käyttää tätä valintaa -file-valinnan sijaan.
-localdirectory -ld Valinnainen. Paikallinen hakemistopolku.
-overwrite -o Valinnainen. Korvaa olemassa oleva tiedosto.
-nocompression -nc Valinnainen. Poista tiedonsiirron pakkaus käytöstä

Esimerkkejä

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

Voit hallita tiedostoja myös Cube Designer -ohjelmassa, Essbase-web-käyttöliittymässä tai REST API -liittymän kautta.

Ohje: komentosyntaksin näyttö

Essbasen CLI-komento help näyttää komentotason ohjeen konsolissa tai päätteessä.

Syntaksi

[command] -help | -h

Esimerkkejä

esscs -help
esscs -h
esscs dataload -help

LcmExport: kuutiotiedostojen varmuuskopiointi

Essbasen CLI-komento lcmexport varmuuskopioi sovellukset ja kuutiosisällöt Lifecycle Management (LCM) -apuohjelman .zip-tiedostoon, jonka se noutaa paikalliselle koneellesi. Tarvitset vähintään sovelluksen pääkäyttäjän oikeudet, jotta voit suorittaa tämän komennon.

Syntaksi

lcmExport [-verbose] -application appname|-allApp -zipfilename filename [-localDirectory path][-threads threadscount][-skipdata][-overwrite][-generateartifactlist][-include-server-level][-cube][-exportdata][-filetype][-exportpartitions][-exportfilters][-restEncryPassword]
Valinta Lyhenne Kuvaus
-verbose -v Valinnainen. Näytä laajennetut kuvaukset.
-application -a Varmuuskopioitavan sovelluksen nimi.
-allApp -aa Valinnainen (ja kirjainkoosta riippuva). Jos tätä käytetään -application-valinnan sijaan, se vie kaikki sovellukset yhteen zip-tiedostoon. lcmimport hyväksyy yhden sovelluksen zip-tiedostoja tai usean sovelluksen zip-tiedostoja.
-zipfilename -z Valinnainen. Varmuuskopiotiedostot sisältävän pakatun tiedoston nimi.
-localdirectory -ld Valinnainen. Paikallinen hakemistopolku. Jos ei muuta ole määritetty, zip-tiedosto tallennetaan polkuun <Application Directory>/catalog/users/<user_name> Essbase-palvelimella.
-threads -T Valinnainen. Polveutettavien säikeiden lukumäärä rinnakkaista vientiä käyttäen. Minimi: 10
-skipdata -skip Valinnainen. Älä sisällytä tietoja varmuuskopioon.
-overwrite -o Valinnainen. Korvaa olemassa oleva varmistustiedosto.
-generateartifactlist -gal Valinnainen. Luo tekstitiedosto, joka sisältää täydellisen listan viedyistä sisällöistä. Tämän tekstitiedoston avulla voit hallita sisältöjen tuontia. Voit esimerkiksi järjestää listalla olevien sisältöjen järjestyksen uudelleen ja valvoa sisältöjen tuontijärjestystä. Voit ohittaa joidenkin sisältöjen tuonnin poistamalla tai kommentoimalla kyseisiä kohteita listalla.
-include-server-level -isl Valinnainen. Sisällytä yleiseksi määritetyt yhteydet ja tietolähteet.
-cube -c Valinnainen. Vie yhden kuution. Tämä valinta voidaan määrittää vain vietävien valintojen ohella: tiedot, tietyn tyyppiset tiedostot, osiot tai suodattimet.
-exportdata -d Valinnainen. Vie vain tiedot.
-filetype -ft

Valinnainen. Vie vain määritetyn tyyppiset tiedostot. Tuettuja tiedostotyyppejä ovat mm. OTL (runko), TXT (teksti), RUL (sääntö), CSC (laskentakomentosarja), DTR (siirtymisraportin määritelmä) ja Excel (vain .xls-tiedostot viedään, ei .xlsx-tiedostoja).

Esimerkkejä:

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

Valinnainen. Vie vain osion määritelmät.

Tuotteen elinkaaren hallinnan (LCM) tuontitoimintoja (ja siirtoapuohjelman tuontia) ei tueta yhdistettyjen osioiden siirrossa. Yhdistetyt osiot on luotava manuaalisesti uudelleen kohteessa.
-exportfilters -ef Valinnainen. Vie vain suojaussuodattimet.
-restEncryPassword -encryPwd

Jos sovellus salataan, tarvitaan salasana suojaamaan salattua sovellusta siirron aikana. Salasanan on oltava 6–15 merkin pituinen, eikä se saa sisältää seuraavia erikoismerkkejä: ?=.,*!@#&()[{}]:;'/~$^+<>-

Varoitus: jos salasana unohtuu, sitä ei voi hakea mistään, eikä sovellusta voi tuoda.

Huomautuksia

Tätä komentoa, kuten muitakin CLI-komentoja, voi käyttää Essbase-koneen ulkopuolelta, kun taas LCM-apuohjelmaa on käytettävä Essbase-koneessa.

Esimerkki

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

Windows-komentojonon esimerkki

Windows-komentojono lcmexportall.bat vie kaikki sovellukset nykyiseen paikalliseen hakemistoon, josta CLI-komentoa kutsuttiin.

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: kuutiotiedostojen palautus

Essbasen CLI-komento lcmimport palauttaa kuutiosisällöt Lifecycle Management (LCM) -apuohjelman .zip-tiedostosta. Sinun on oltava joko sovelluksen luonut tehokäyttäjä tai palvelun järjestelmänvalvoja, jotta voit suorittaa komennon.

Syntaksi

lcmImport [-verbose] -zipfilename filename [-overwrite] [-targetappName targetApplicationName][-include-server-level][-artifactlist artifactList][-restEncryPassword]
Valinta Lyhenne Kuvaus
-verbose -v Valinnainen. Näytä laajennetut kuvaukset.
-zipfilename -z Varmuuskopiotiedostot sisältävän pakatun tiedoston nimi.
-overwrite -o Valinnainen. Luo kohdesovellus uudelleen.
-targetappName -ta Valinnainen. Kohdesovelluksen nimi, jos haluat, että se on eri kuin lähteen nimi.
-artifactlist -al Valinnainen. Tuotavien artefaktien luettelon sisältävän tuontitiedoston nimi. Tämä tiedosto voidaan generoida lcmexport-komennolla.

Jos haluat ohittaa sisältöjä, kommentoi tai poista listalla olevia merkintöjä. Jos haluat esimerkiksi ohittaa tarkistustietueiden tuonnin, kommentoi kyseistä riviä seuraavasti:

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

Voit valvoa tuontijärjestystä järjestämällä tuontimerkinnät uudelleen tekstitiedostossa.

Jos käytetään –overwrite-argumenttia, tuontitoiminto poistaa koko sovelluksen ja luo sen uudelleen tuoden vain listalla olevat sisällöt. Jos –overwrite-argumenttia ei käytetä, tuontitoiminto sisältää listalla määritetyt sisällöt vaikuttamatta muihin sisältöihin, jotka ovat jo kohdesovelluksessa.
-include-server-level -isl Valinnainen. Sisällytä yleiseksi määritetyt yhteydet ja tietolähteet.
-restEncryPassword -encryPwd

Jos sovellus salataan, tarvitaan salasana suojaamaan salattua sovellusta siirron aikana. Salasanan on oltava 6–15 merkin pituinen, eikä se saa sisältää seuraavia erikoismerkkejä: ?=.,*!@#&()[{}]:;'/~$^+<>-

Varoitus: jos salasana unohtuu, sitä ei voi hakea mistään, eikä sovellusta voi tuoda.

Huomautuksia

  • Tätä komentoa, kuten muitakin CLI-komentoja, voi käyttää Essbase-koneen ulkopuolelta, kun taas LCM-apuohjelmaa on käytettävä Essbase-koneessa.

  • Kun LCM-tuonti on valmis, tarvitaan ehkä vielä lisätoimia siirrettyjen yhteyksien palauttamiseksi ulkoisiin lähteisiin. Tee tämä avaamalla yhteys ja syöttämällä salasana.

  • Kun siirrettävien kuutioiden välillä on osioita, tietolähde on siirrettävä ennen tietokohdetta. Muutoin osioiden määrityksiä ei välttämättä voida palauttaa.

    Tuotteen elinkaaren hallinnan (LCM) tuontitoimintoja (ja siirtoapuohjelman tuontia) ei tueta yhdistettyjen osioiden siirrossa. Yhdistetyt osiot on luotava manuaalisesti uudelleen kohteessa.

  • LCM-tuonti ei siirrä sijainnin aliastunnuksia. Sijainnin aliastunnukset on korvattava joko luomalla sijainnin aliakset uudelleen MaxL:n avulla tai muokkaamalla sijainnin aliastunnuksia LCM-viennin viemässä XML-tiedostossa.

Esimerkki

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

Listapp: näytä sovellukset

CLI-komento listapp luetteloi sovellukset, joihin sinulla on käyttöoikeus tässä Essbase-instanssissa.

Syntaksi

listapp [-verbose] [-details]
Valinta Lyhenne Kuvaus
-verbose -v Valinnainen. Näytä laajennetut kuvaukset.
-details -dtl Valinnainen. Näytä enemmän tietoja tulosteessa (sovellustyyppi ja nykyinen tila).

Esimerkki

esscs listapp -v -dtl

Listdb: kuutioiden näyttö

CLI-komento listdb luetteloi tietokannat, joiden käyttöoikeus sinulla on tietyssä Essbase-sovelluksessa.

Syntaksi

listdb [-verbose] -application applicationName [details]
Valinta Lyhenne Kuvaus
-verbose -v Valinnainen. Näytä laajennetut kuvaukset.
-application -a Sovelluksen nimi.
-details -dtl Valinnainen. Näytä tilatiedot tulosteessa.

Esimerkki

esscs listdb -v -a Sample -dtl

Listfiles: tiedostojen näyttö

CLI-komento listfiles luetteloi Essbase-instanssissa olevat kuutiosisällöt.

Kuutiosisällöt voivat sisältää datatiedostoja, työkirjoja, sääntötiedostoja, laskentakomentosarjoja tai muuta sisältöä. Kuutioartefaktit ovat tiedostoja, joita tarvitaan toimien suoritukseen sovelluksissa ja kuutioissa.

Jotta voisit luetteloida kuution tiedostot, sinulla on oltava vähintään tietokannan käyttöoikeudet sovellukseen. Käyttäjähakemiston tiedostojen luetteloimiseen ei tarvita erityisiä oikeuksia.

Syntaksi

listfiles [-verbose] [-type filetype] [-application appname [-db cubename] | -catalogpath catalogPath]
Valinta Lyhenne Kuvaus
-verbose -v Valinnainen. Näytä laajennetut kuvaukset.
-type -t Valinnainen. Näytettävä tiedostotunniste-/tyyppi ilman pistettä.

Näitä tiedostoja tuetaan:

  • .csc (laskentakomentosarjat)
  • .rul (sääntötiedostot)
  • .txt (tekstitiedostot)
  • .msh (MaxL-komentosarjat)
  • .xls, .xlsx (Excel-työkirjat)
  • .xlsm (Excel-työkirjat, joissa makrot on otettu käyttöön)
  • .xml (XML-tiedostot)
  • .zip (pakatut zip-tiedostot)
  • .csv (pilkuilla erotetut tiedostot)
-application -a Valinnainen. Sovelluksen nimi. Jos tätä arvoa ei määritetä, näytetään käyttäjän kotihakemiston tiedostot.
-db -d Valinnainen. Tietokannan (kuution) nimi.
-catalogpath -CP Valinnainen. Tiedostonimen luettelopolku. Tämän avulla voit määrittää tiedostojen luettelosijainnin -a [-d] -valinnan sijaan.

Esimerkkejä

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

Voit hallita tiedostoja myös Cube Designer -ohjelmassa, Essbase-web-käyttöliittymässä tai REST API -liittymän kautta.

Listfilters: suojaussuodattimien katselu

CLI-komento listfilters näyttää luettelon Essbase-suojaussuodattimista. Sovelluksen kuutioiden suodattimien katselu edellyttää vähintään tietokannan pääkäyttäjän oikeuksia.

Syntaksi

listfilters [-verbose] -application appname -db cubename
Valinta Lyhenne Kuvaus
-verbose -v Valinnainen. Näytä laajennetut kuvaukset.
-application -a Sovelluksen nimi.
-db -d Tietokannan (kuution) nimi.

Esimerkki

esscs listfilters -v -a Sample -d Basic

Listlocks: lukitusten katselu

Essbasen CLI-komento listlocks näyttää mahdolliset lukitut tietolohkot tai kuutioihin liittyvät objektit. Tarvitset sovellukseen vähintään tietokannan käyttöoikeuden, jotta voit suorittaa komennon.

Syntaksi

listlocks [-verbose] -application appname -db cubename [-object]
Valinta Lyhenne Kuvaus
-verbose -v Valinnainen. Näytä laajennetut kuvaukset.
-application -a Sovelluksen nimi.
-db -d Tietokannan (kuution) nimi.
-object -obj Valinnainen. Näytä lukitut tiedosto/artefaktit.

Esimerkki

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

Listvariables: korvausmuuttujien näyttö

Essbasen CLI-komento listvariables luetteloi korvausmuuttujat, jotka on määritetty kuution tai sovelluksen laajuudessa tai yleisessä laajuudessa. Tarvitset vähintään tietokannan käyttöoikeudet kuution muuttujien tarkasteluun, sovelluksen pääkäyttäjän roolin sovelluksen muuttujien tarkasteluun ja palvelun pääkäyttäjän roolin yleisten muuttujien tarkasteluun.

Syntaksi

listvariables [-verbose] [-application application [-db database]]
Valinta Lyhenne Kuvaus
-verbose -v Näytä laajennetut kuvaukset.
-application -a Valinnainen. Sovelluksen nimi.
-database -db Valinnainen. Tietokannan (kuution) nimi.

Esimerkkejä

Kuutiotaso

esscs listvariables -a Sample -db Basic

Sovellustaso

esscs listvariables -a Sample

Yleinen taso

esscs listvariables

Setpassword: CLI-valtuuksien tallennus

Essbasen CLI-komento setpassword tallentaa työasema/käyttäjä-yhdistelmään liitetyn salasanan. Tämän jälkeen voit kirjautua istuntoihin antamatta salasanaa.

Syntaksi

 setpassword [-verbose] -essbaseurl URL -user userName
Valinta Lyhenne Kuvaus
-verbose -v Valinnainen. Näytä laajennetut kuvaukset.
-essbaseurl -url Essbase-instanssin osoite
-user -u Käyttäjätunnuksesi

Huomautuksia

Versioon 21.4 tai uudempaan siirtymisen jälkeen tällä komennolla edellisessä versiossa tallennetut salasanat täytyy nollata.

Esimerkki

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

Start: sovelluksen tai kuution käynnistys

CLI-komento start käynnistää Essbase-sovelluksen tai -kuution ja lataa sen muistiin. Tarvitset sovellukseen vähintään tietokannan käyttöoikeuden, jotta voit suorittaa komennon.

Syntaksi

start [-verbose] -application appname [-db cubename]
Valinta Lyhenne Kuvaus
-verbose -v Valinnainen. Näytä laajennetut kuvaukset.
-application -a Sovelluksen nimi.
-db -d Valinnainen. Tietokannan (kuution) nimi.

Esimerkki

esscs start -v -a Sample -d Basic

Stop: sovelluksen tai kuution pysäytys

CLI-komento stop pysäyttää Essbase-sovelluksen tai -kuution. Tarvitset sovellukseen vähintään tietokannan käyttöoikeuden, jotta voit suorittaa komennon.

Syntaksi

stop [-verbose] -application appname [-db cubename]
Valinta Lyhenne Kuvaus
-verbose -v Valinnainen. Näytä laajennetut kuvaukset.
-application -a Sovelluksen nimi.
-db -d Valinnainen. Tietokannan (kuution) nimi.

Esimerkki

esscs stop -v -a Sample -d Basic

Unsetpassword: Poista tallennetut CLI-valtuudet

Essbasen CLI-komento unsetpassword poistaa tallennetut työasema/käyttäjä-yhdistelmääsi liitetyt kirjautumistiedot. Se kumoaa setpassword-komennon vaikutukset.

Syntaksi

unsetpassword [-verbose] -essbaseurl URL -user userName
Valinta Lyhenne Kuvaus
-verbose -v Näytä laajennetut kuvaukset.
-essbaseurl -url Essbase-instanssin osoite
-user -u Käyttäjä, jonka salasana poistetaan

Esimerkki

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

Upload: kuutiotiedostojen lisäys

CLI-komento upload lataa kuutiosisällöt paikallisesta hakemistosta Essbase-instanssiin.

Joidenkin tehtävien (kuten tietojen latauksen, dimension muodostuksen, laskutoimitusten tai muiden toimintojen) suorittamista varten sinun on ehkä ladattava datatiedostoja, sääntötiedostoja, laskentakomentosarjatiedostoja tai muita sisältöjä kuution hakemistoon. Voit ladata artefaktit myös käyttäjähakemistoosi.

Jotta voisit ladata tiedostoja kuutioon, sinulla on oltava vähintään tietokannan pääkäyttäjän oikeudet. Käyttäjähakemistoon lataamiseen ei tarvita erityisiä oikeuksia.

Huomautus::

Voit ottaa käyttöön virustorjuntatarkastuksen Essbase-web-liittymässä, jolloin tiedostoille suoritetaan virustarkastus ennen kuin ne ladataan palvelimelle.

Syntaksi

upload [-verbose] -file filename [-application appname [-db cubename] | -catalogpath catalogPath] [-overwrite] [-nocompression][-compressionalgorithm]
Valinta Lyhenne Kuvaus
-verbose -v Valinnainen. Näytä laajennetut kuvaukset.
-file -f Ladattavan tiedoston nimi

Huomautus::

Tiedostopäätteet on kirjoitettava pienillä kirjaimilla. Esimerkiksi tiedostonimi.txt.
-application -a Valinnainen. Sovelluksen nimi. Jos tätä ei määritetä, tiedostot ladataan käyttäjähakemistoosi tai -CP-valinnalla määritettyyn luettelopolkuun.
-db -d Valinnainen. Tietokannan (kuution) nimi. Edellyttää -a-valinnan.
-catalogpath -CP Valinnainen. Tiedostonimen luettelopolku. Tämän avulla voit määrittää tiedoston luettelosijainnin -a [-d] -valinnan sijaan.
-overwrite -o Valinnainen. Korvaa olemassa oleva tiedosto.
-nocompression -nc Valinnainen. Poista tiedonsiirron pakkaus käytöstä
-compressionalgorithm -ca Valinnainen. Käytettävissä, jos -nc ei ole käytössä. Määrittää, mitä pakkausalgoritmia tiedonsiirrossa käytetään. Mahdolliset valinnat: gzip tai lz4.

  • gzip — Oletusarvo, jos käytetään pakkausta. Tarjoaa pienemmän tiedonsiirtomäärän ja hitaammat laskutoimitukset.

  • lz4 — Tarjoaa nopeammat laskutoimitukset ja hitaamman tiedonsiirron.

Käyttöesimerkkejä:

-ca gzip
-ca lz4

Esimerkkejä

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

Voit hallita tiedostoja myös Cube Designer -ohjelmassa, Essbase-web-käyttöliittymässä tai REST API -liittymän kautta.

Version: API-version näyttö

CLI-komento version hakee tähän Essbase-instanssiin liitetyn REST API -liittymän version.

Syntaksi

version

Esimerkki

esscs version