Référence de commande CLI

Pour pouvoir émettre d'autres commandes CLI vers Essbase, vous devez vous connecter. Si une connexion sécurisée est requise, l'URL doit commencer par https.

Avec l'interface de ligne de commande, vous pouvez vous authentifier des manières suivantes :

• Utilisez setpassword à une reprise afin que le mot de passe soit stocké pour la combinaison client/utilisateur. Lors des sessions ultérieures, vous pouvez utiliser la commande login sans avoir à entrer de mot de passe.
• Utilisez les options -user et -password avec la commande login (attention : le mot de passe apparaît en clair dans la fenêtre de l'interpréteur de commandes).
• Utilisez uniquement l'option -user avec la commande login. Vous êtes invité à saisir le mot de passe, qui est masqué.

Si vous êtes un utilisateur SSO fédéré dans Oracle Identity Cloud Service, vous ne pouvez pas vous connecter avec MaxL ni avec l'interface de ligne de commande. La connexion SSO fédérée nécessite une fenêtre de navigateur. Créez un utilisateur Identity Cloud Service natif et utilisez-le pour vous connecter avec MaxL ou l'interface de ligne de commande.

Syntaxe (login)

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

Exemple 1 (connexion)

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

Exemple 2 (connexion)

Dans l'exemple suivant, l'utilisateur se connectant, admin1@example.com, est un administrateur Identity Cloud Service défini comme administrateur Essbase initial pendant le déploiement de pile d'Essbase sur Oracle Cloud Infrastructure. Le mot de passe n'étant pas saisi dans cet exemple, l'administrateur sera invité à le fournir à l'étape suivante. L'URL est définie sur essbase_url à partir des sorties de job provenant de la pile déploiement.

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

Syntaxe (logout)

logout

Exemple (logout)

esscs logout

Pour pouvoir exécuter des scripts de calcul, vous devez d'abord charger les scripts en tant que fichiers .csc vers le répertoire de cube. Pour ce faire, vous pouvez utiliser CLI. Reportez-vous à Upload : ajout de fichiers de cube.

Syntaxe

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

Exemple

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

Vous pouvez également exécuter les scripts de calcul à l'aide de l'option Calculer dans le concepteur de cubes ou dans Smart View, de Jobs dans l'interface Web Essbase ou l'API REST, ou de la commande exécuter les calculs dans MaxL.

Syntaxe

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

Exemple

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

Vous pouvez également effacer les données à l'aide de l'option Charger les données dans le concepteur de cubes, de Jobs dans l'interface Web Essbase ou l'API REST, ou de alter database DBS-NAME reset dans MaxL.

Description

Un administrateur de service doit utiliser cette commande afin de créer et d'enregistrer la connexion locale pour pouvoir utiliser les commandes CLI dataload ou dimbuild avec l'option de transmission en continu. Vous devez également définir une variable d'environnement EXTERNAL_CLASSPATH de sorte qu'elle pointe vers le fichier .jar de votre pilote de base de données (reportez-vous à Construction de dimensions et chargement de données par transmission en continu à partir d'une base de données distante).

Syntaxe

createLocalConnection [-verbose] -name streamConnection -connectionstring  connectionString -user userName [-driver jdbcDriver] [-password password]

jdbc:oracle:thin:@host:port/service_name

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

Si vous disposez d'une connectivité réseau entre une source de données externe et Essbase, il est plus efficace de définir des connexions et des sources de données globales ou de niveau application dans l'interface Web Essbase. Ces définitions vous aident à facilement "extraire" les données de la source externe. Si vous ne disposez pas d'une connectivité réseau entre Essbase et la source de données externe, vous devez alors transmettre les chargements de données ou les constructions de dimension à l'aide de l'interface de ligne de commande, en utilisant d'abord cette commande pour créer une connexion locale et en émettant ensuite le chargement de données ou la commande dimbuild avec l'option de flux de données.

Remarques

Une fois la migration vers la version 21.4 ou supérieure terminée, l'administrateur de service doit recréer les éventuelles connexions locales enregistrées qui ont été créées à l'aide de cette commande dans une version précédente.

Exemples

Cette commande exige l'un des ensembles d'options suivants :

• Fichier de données et fichier de règles facultatif

• Fichier de règles avec nom d'utilisateur et mot de passe

• Option stream faisant référence à une connexion locale enregistrée

La base de données source doit être accessible au sein du réseau client, car tous les pilotes de base de données ne peuvent pas fonctionner avec les proxies Java.

Pour charger des données, vous devez d'abord télécharger les fichiers de règles et de chargement de données vers le répertoire de cube. Pour ce faire, vous pouvez utiliser CLI. Reportez-vous à Upload : ajout de fichiers de cube.

Syntaxe

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]

Exemples

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"

Vous pouvez également charger les données à l'aide du concepteur de cubes, de Jobs dans l'interface Web Essbase ou l'API REST, ou de la commande import data dans MaxL.

Syntaxe

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

Exemples

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

esscs deletefile -CF /shared/Data.txt

Vous pouvez également gérer les fichiers dans le concepteur de cubes, l'interface Web Essbase ou l'API REST.

Syntaxe

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

Exemples

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

Vous pouvez également déployer des cubes à l'aide du concepteur de cubes ou de l'option Importer dans la section Applications de l'interface Web Essbase.

Pour pouvoir charger des dimensions, vous devez d'abord charger les fichiers de règles et de construction de dimension vers Essbase. Pour ce faire, vous pouvez utiliser CLI. Reportez-vous à Upload : ajout de fichiers de cube.

Syntaxe

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]

Exemples

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

Vous pouvez également charger les dimensions à l'aide du concepteur de cubes, de Jobs dans l'interface Web Essbase ou l'API REST, ou de la commande import dimensions dans MaxL.

Vous pouvez avoir besoin de télécharger des fichiers texte, des fichiers de règles ou des fichiers de script de calcul à partir d'un cube, afin de les utiliser ou de les charger vers un autre cube. Pour télécharger des artefacts de cube, vous devez disposer au moins de l'autorisation Mise à jour de la base de données.

Syntaxe

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

Exemples

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

Vous pouvez également gérer les fichiers dans le concepteur de cubes, l'interface Web Essbase ou l'API REST.

Syntaxe

[command] -help | -h

Exemples

esscs -help

esscs -h

esscs dataload -help

Syntaxe

lcmExport [-verbose] -application appname|-allApp -zipfilename filename [-localDirectory path][-threads threadscount][-skipdata][-overwrite][-generateartifactlist][-include-server-level][-cube][-exportdata][-filetype][-exportpartitions][-exportfilters][-restEncryPassword]

esscs lcmexport -a sample -z sampleXLSOnly.zip -v -ft excel

esscs lcmexport -a sample -z sampleTXTOnly.zip -v -ft txt

Remarques

Cette commande, de même que d'autres commandes CLI, peut être utilisée en dehors de l'ordinateur Essbase, alors que l'utilitaire LCM doit être exécuté sur cet ordinateur Essbase.

Exemple

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

Exemple de script Windows

Le script Windows lcmexportall.bat exporte toutes les applications vers le répertoire local en cours à partir duquel l'interface de ligne de commande a été appelée.

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

Syntaxe

lcmImport [-verbose] -zipfilename filename [-overwrite] [-targetappName targetApplicationName][-include-server-level][-artifactlist artifactList][-restEncryPassword]

# ------------IMPORT-----------------
import @Provisions
import @Databases/Basic
#import @Databases/Basic/Audit
import @Databases/Basic/Text_files
import @Databases/Basic/Xml_files
import @Databases/Basic/Calc_scripts
import @Databases/Basic/Open_XML_Excel_files
import @Databases/Basic/ScenarioManagement
import @Databases/Basic/Provisions
import @Databases/Basic/Rule_files

Remarques

• Cette commande, de même que d'autres commandes CLI, peut être utilisée en dehors de l'ordinateur Essbase, alors que l'utilitaire LCM doit être exécuté sur cet ordinateur Essbase.

• Une fois l'import LCM terminé, il se peut que vous deviez effectuer d'autres actions pour restaurer les connexions migrées vers des sources externes. Pour cela, ouvrez la connexion et saisissez le mot de passe.

• Lorsque des partitions sont présentes entre les cubes à migrer, vous devez importer la source de données avant la cible de données. Sinon, les définitions de partition risquent de ne pas pouvoir être restaurées.

  Les opérations d'import de gestion du cycle de vie (ainsi que de l'utilitaire de migration) ne sont pas prises en charge pour la migration des partitions fédérées. Les partitions fédérées doivent être recréées manuellement sur la cible.

• L'import LCM ne migre pas les informations d'identification d'alias d'emplacement. Vous devez remplacer vos informations d'identification d'alias d'emplacement en recréant des alias d'emplacement à l'aide de MaxL ou en modifiant les informations d'identification d'alias d'emplacement dans le fichier XML exporté par l'export LCM.

Exemple

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

Syntaxe

listapp [-verbose] [-details]

Exemple

esscs listapp -v -dtl

Syntaxe

listdb [-verbose] -application applicationName [details]

Exemple

esscs listdb -v -a Sample -dtl

Les artefacts de cube peuvent inclure des fichiers de données, des classeurs, des fichiers de règles, des fichiers de script de calcul ou d'autres artefacts. Ils incluent tous les fichiers nécessaires à la réalisation d'actions sur des applications et des cubes.

Pour répertorier les fichiers d'un cube, vous devez au moins disposer pour celui-ci de l'autorisation Accès à la base de données. Aucune autorisation spéciale n'est requise pour répertorier les fichiers du répertoire utilisateur.

Syntaxe

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

Exemples

esscs listfiles -t rul -a Sample -d Basic 

esscs listfiles -CP "/shared"

Vous pouvez également gérer les fichiers dans le concepteur de cubes, l'interface Web Essbase ou l'API REST.

Syntaxe

listfilters [-verbose] -application appname -db cubename 

Exemple

esscs listfilters -v -a Sample -d Basic 

Syntaxe

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

Exemple

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

Syntaxe

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

Exemples

Niveau du cube

esscs listvariables -a Sample -db Basic

Niveau application

esscs listvariables -a Sample

Niveau global

esscs listvariables

Syntaxe

 setpassword [-verbose] -essbaseurl URL -user userName

Remarques

Après la migration vers la version 21.4 ou supérieure, vous devez réinitialiser tous les mots de passe stockés qui ont été enregistrés dans une version précédente à l'aide de cette commande.

Exemple

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

Syntaxe

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

Exemple

esscs start -v -a Sample -d Basic

Syntaxe

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

Exemple

esscs stop -v -a Sample -d Basic 

Syntaxe

unsetpassword [-verbose] -essbaseurl URL -user userName

Exemple

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

Pour effectuer des tâches telles que des chargements de données, des constructions de dimension, des calculs ou autres, vous devrez peut-être télécharger vers le répertoire de cube des fichiers de données, des fichiers de règles, des fichiers de script de calcul ou d'autres artefacts. Vous pouvez également télécharger les artefacts vers le répertoire utilisateur.

Pour télécharger des fichiers vers un cube, vous devez au moins disposer de l'autorisation Gestionnaire de base de données. Aucune autorisation spéciale n'est requise pour un téléchargement vers le répertoire utilisateur.

Syntaxe

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

-ca gzip

-ca lz4

Exemples

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

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

Vous pouvez également gérer les fichiers dans le concepteur de cubes, l'interface Web Essbase ou l'API REST.

Syntaxe

version

Exemple

esscs version