Référence aux commandes de l'interface de ligne de commande

Avant de pouvoir émettre toute autre commande d'interface de ligne de commande dans Essbase, vous devez vous connecter. Si une connexion sécurisée est requise, l'URL doit commencer par https.

Vous pouvez vous identifier des manières suivantes à l'aide de l'interface de ligne de commande :

• Utilisez setpassword une fois pour stocker le mot de passe de votre combinaison client-utilisateur. Dans les sessions suivantes, vous pourrez utiliser la commande login sans entrer de mot de passe.
• Utilisez les options -user et -password avec la commande login (Attention : Le mot de passe s'affiche dans la fenêtre de l'interpréteur de commandes en texte clair).
• Utilisez uniquement l'option -user avec la commande login. Vous êtes invité à entrer le mot de passe, qui est masqué.

Si vous êtes un utilisateur de l'authentification unique fédérée dans le service Oracle Identity Cloud, la connexion à l'aide de MaxL ou de l'interface de ligne de commande n'est pas prise en charge. La connexion d'utilisateur au moyen de l'authentification unique fédérée requiert une fenêtre de navigateur. Créez un utilisateur natif du service Identity Cloud et utilisez-le pour vous connecter à l'aide de MaxL ou de l'interface de ligne de commande.

Syntaxe (connexion)

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@exemple.com est un administrateur du service Identity Cloud qui a été défini comme l'administrateur Essbase initial lors du déploiement de la pile Essbase sur Oracle Cloud Infrastructure. Comme le mot de passe n'est pas indiqué dans cet exemple, l'administrateur sera invité à le fournir. L'URL est essbase_url issue des sorties du travail résultant du déploiement de la pile.

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

Syntaxe (déconnexion)

logout

Exemple (déconnexion)

esscs logout

Avant de pouvoir exécuter des scripts de calcul, vous devez d'abord les charger dans le répertoire du cube sous forme de fichiers .csc. Pour ce faire, vous pouvez utiliser l'interface de ligne de commande. Voir upload : Ajouter des 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 des scripts de calcul à l'aide de l'option Calculer du Concepteur de cube ou de Smart View, Travaux dans l'interface Web d'Essbase ou l'API REST, ou de l'énoncé execute calculation 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 des données à l'aide de l'option Charger les données sous Concepteur de cube, Travaux dans l'interface Web d'Essbase ou l'API REST, ou avec l'énoncé alter database DBS-NAME reset dans MaxL.

Description

Un administrateur de service doit utiliser cette commande pour créer et enregistrer la connexion locale avant que les commandes dataload ou dimbuild de l'interface de ligne de commande puissent être utilisées avec l'option de mode continu. Vous devez également définir une variable d'environnement EXTERNAL_CLASSPATH pour pointer vers le fichier .jar du pilote de la base de données (voir Créer des dimensions et charger des données par diffusion 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 des données externe et Essbase, il est plus efficace de définir des connexions et des sources de données au niveau global et de l'application dans l'interface Web d'Essbase. Ces définitions vous aident à "extraire" facilement des données de la source externe. En l'absence de connectivité réseau entre Essbase et la source des données externe, vous pouvez exécuter les chargements de données ou les créations de dimension à l'aide de l'interface de ligne de commande en utilisant d'abord cette commande pour créer une connexion locale, puis en transmettant la commande dataload ou dimbuild avec l'option de flux.

Notes

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

Exemples

Cette commande requiert un des jeux 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 de flux faisant référence à une connexion locale enregistrée

La base de données doit être accessible dans le réseau client, car tous les pilotes de base de données ne fonctionnent pas avec des mandataires Java.

Pour charger des données, vous devez d'abord charger le chargement de données ainsi que les fichiers de règles dans le répertoire du cube. Pour ce faire, vous pouvez utiliser l'interface de ligne de commande. Voir upload : Ajouter des 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 des données en sélectionnant Concepteur de cube, Tâches dans l'interface Web d'Essbase ou en utilisant l'API REST, ou l'énoncé 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 des fichiers dans le Concepteur de cube, l'interface Web d'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 cube ou de l'option Importer dans la section Applications de l'interface Web d'Essbase.

Avant de pouvoir charger des dimensions, vous devez d'abord charger les fichiers de création de dimension et de règles dans Essbase. Pour ce faire, vous pouvez utiliser l'interface de ligne de commande. Voir upload : Ajouter des 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 des dimensions en sélectionnant Concepteur de cube, Tâches dans l'interface Web d'Essbase ou en utilisant l'API REST, ou l'énoncé import dimensions dans MaxL.

Vous aurez peut-être besoin de télécharger des fichiers texte, de règles ou de script de calcul à partir d'un cube pour pouvoir les utiliser ou les charger dans 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 des fichiers dans le concepteur de cube, l'interface Web d'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

Notes

Vous pouvez utiliser cette commande, comme d'autres commandes d'interface de ligne de commande, en dehors de la machine Essbase, alors que vous devez exécuter l'utilitaire LCM sur cette dernière.

Exemple

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

Exemple de script Windows

Le script Windows suivant, lcmexportall.bat, exporte toutes les applications dans le répertoire local courant à 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

Notes

• Vous pouvez utiliser cette commande, comme d'autres commandes d'interface de ligne de commande, en dehors de la machine Essbase alors que vous devez exécuter l'utilitaire LCM dans cette dernière.

• Une fois l'importation LCM terminée, vous devrez peut-être aussi restaurer les connexions migrées aux sources externes. Pour ce faire, ouvrez la connexion et entrez le mot de passe.

• Lorsque des partitions existent entre des cubes en cours de migration, vous devez importer la source de données avant la cible. Sinon, les définitions de partition ne peuvent être restaurées.

  Les opérations d'importation du processus de gestion du cycle de vie (LCM), et celles de l'utilitaire de migration, ne sont pas prises en charge pour la migration de partitions fédérées. Les partitions fédérées doivent être recréées manuellement sur la cible.

• L'importation LCM ne migre pas les données d'identification d'alias d'emplacement. Vous devez remplacer les données d'identification d'alias d'emplacement, soit en recréant les alias d'emplacement à l'aide de MaxL, soit en modifiant les données d'identification d'alias d'emplacement dans le XML exporté par l'exportation 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 être des fichiers de données, des classeurs, des fichiers de règles, des fichiers de script de calcul ou d'autres artefacts. Ils comprennent n'importe quel fichier nécessaire à l'exécution d'actions dans les applications et les cubes.

Pour lister les fichiers d'un cube, vous devez disposer au moins du rôle d'utilisateur Accès à la base de données pour l'application. Aucune autorisation spéciale n'est nécessaire pour lister les fichiers de votre répertoire d'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 des fichiers dans le Concepteur de cube, l'interface Web d'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 de l'application

esscs listvariables -a Sample

Niveau global

esscs listvariables

Syntaxe

 setpassword [-verbose] -essbaseurl URL -user userName

Notes

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

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 comme les chargements de données, les créations de dimension, les calculs ou d'autres opérations, vous aurez besoin de charger des fichiers de données, de règles, de script de calcul ou d'autres artefacts dans le répertoire du cube. Vous pouvez également charger les artefacts dans votre répertoire d'utilisateur.

Vous devez disposer au moins de l'autorisation Gestionnaire de base de données afin de charger des fichiers dans un cube. Aucune autorisation spéciale n'est nécessaire pour effectuer des chargements dans votre répertoire d'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 des fichiers dans le Concepteur de cube, l'interface Web d'Essbase ou l'API REST.

Syntaxe

version

Exemple

esscs version