Referencia de los comandos de CLI

Antes de emitir cualquier otro comando de CLI a Essbase, es obligatorio conectarse. Si necesita una conexión segura, la URL debe comenzar por https.

Mediante CLI, un usuario puede autenticarse de las siguientes formas:

• Utilice setpassword una sola vez para almacenar la contraseña relativa a la combinación de cliente/usuario. En sesiones consecutivas, se puede utilizar el comando login sin que sea necesario introducir una contraseña.
• Utilice las opciones -user y -password junto con el comando login. (Atención: la contraseña aparece en la ventana de shell como texto no cifrado).
• Utilice únicamente la opción -user junto con el comando login. Se pedirá la contraseña, que aparece oculta.

Si es usuario de SSO federada en Oracle Identity Cloud Service, conéctese con MaxL, de lo contrario CLI no se soportará. La conexión de SSO federada requiere una ventana del explorador. Cree un usuario nativo de Identity Cloud Service y utilícelo en lugar de conectarse mediante MaxL o CLI.

Sintaxis (conexión)

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

Ejemplo 1 (conexión)

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

Ejemplo 2 (conexión)

En el siguiente ejemplo, el usuario que se conecta, admin1@example.com, es un administrador de Identity Cloud Service que se ha definido como administrador inicial de Essbase durante el despliegue de pila de Essbase en Oracle Cloud Infrastructure. Debido a que no se ha introducido la contraseña en este ejemplo, se solicitará al administrador que la proporcione a continuación. La URL es la essbase_url de las salidas de trabajo que se producen como consecuencia del despliegue de pila.

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

Sintaxis (desconexión)

logout

Ejemplo (desconexión)

esscs logout

Antes de ejecutar scripts de cálculo, tiene que cargar los scripts, como archivos .csc, al directorio de cubo. Puede utilizar la herramienta CLI para cargar archivos. Consulte Upload: Adición de archivos de cubo.

Sintaxis

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

Ejemplo

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

También puede ejecutar los scripts de cálculo con la opción Calcular del diseñador de cubos o Smart View, Trabajos en la interfaz web de Essbase o la API de REST, o execute calculation en MaxL.

Sintaxis

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

Ejemplo

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

También puede borrar los datos con la opción Cargar datos en Diseñador de cubos, Trabajos en la interfaz web de Essbase o la API de REST, o bien alter database DBS-NAME reset en MaxL.

Descripción

Un administrador de servicio debe utilizar este comando para crear y guardar la conexión local antes de que alguien pueda usar los comandos de CLI dataload o dimbuild con la opción de flujo. También debe definir una variable de entorno EXTERNAL_CLASSPATH que apunte al archivo .jar del controlador de base de datos (consulte Creación de dimensiones y carga de datos mediante streaming desde una base de datos remota).

Sintaxis

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 tiene conectividad de red entre un origen de datos externo y Essbase, resulta más eficiente definir conexiones y orígenes de datos de nivel de aplicación o globales en la interfaz web de Essbase. Estas definiciones le permiten "extraer" fácilmente datos del origen externo. Si no tiene conectividad de red entre Essbase y el origen de datos externo, puede crear corrientes de cargas de datos o creaciones de dimensiones con CLI, en primer lugar usando este comando para crear una conexión local y, a continuación, emitiendo el comando dataload o dimbuild con la opción stream.

Notas

Después de migrar a la versión 21.4 o superior, el administrador del servicio debe volver a crear todas las conexiones locales guardadas que se hayan creado mediante este comando en una versión anterior.

Ejemplos

Este comando necesita uno de los siguientes juegos de opciones:

• Archivo de datos y archivo de reglas opcional

• Archivo de reglas con nombre de usuario y contraseña

• Opción de flujo que hace referencia a una conexión local guardada

La base de datos de origen debe poder ser accesible en la red del cliente, ya que no todos los controladores de la base de datos pueden funcionar con proxies de Java.

Para cargar datos, primero debe cargar los archivos de reglas y carga de datos en el directorio de cubo. Puede utilizar la herramienta CLI para cargar archivos. Consulte Upload: Adición de archivos de cubo.

Sintaxis

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]

Ejemplos

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"

También puede cargar los datos con el diseñador de cubos, Trabajos, en la interfaz web de Essbase o la API de REST, o bien Importar datos en MaxL.

Sintaxis

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

Ejemplos

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

esscs deletefile -CF /shared/Data.txt

También puede gestionar archivos en el diseñador de cubos, la interfaz web de Essbase o la API de REST.

Sintaxis

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

Ejemplos

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

También puede desplegar cubos con el diseñador de cubos o mediante la opción Importar en la sección Aplicaciones de la interfaz web de Essbase.

Antes de que pueda cargar dimensiones, debe cargar los archivos de creación de dimensión y de reglas en Essbase. Puede utilizar la herramienta CLI para cargar archivos. Consulte Upload: Adición de archivos de cubo.

Sintaxis

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]

Ejemplos

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

También puede cargar dimensiones con el diseñador de cubos, Trabajos, en la interfaz web de Essbase o la API de REST, o bien Importar dimensiones en MaxL.

Puede que tenga que descargar archivos de texto, archivos de reglas o archivos de script de cálculo de un cubo para poder trabajar en ellos o cargarlos en otro cubo. Para descargar artefactos de cubo, necesita al menos permiso de actualización de base de datos.

Sintaxis

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

Ejemplos

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

También puede gestionar archivos en el diseñador de cubos, la interfaz web de Essbase o la API de REST.

Sintaxis

[command] -help | -h

Ejemplos

esscs -help

esscs -h

esscs dataload -help

Sintaxis

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

Notas

Este comando, al igual que otros comandos CLI, se puede utilizar desde fuera de la máquina de Essbase, mientras que la utilidad LCM se debe ejecutar en la máquina de Essbase.

Ejemplo

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

Ejemplo de script de Windows

El script de Windows lcmexportall.bat exporta todas las aplicaciones en el directorio local actual desde el que se ha llamado a la CLI.

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

Sintaxis

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

Notas

• Este comando, al igual que otros comandos CLI, se puede utilizar desde fuera de la máquina de Essbase, mientras que la utilidad LCM se debe ejecutar en la máquina de Essbase.

• Cuando la importación de LCM finalice, puede que deba tomar más medidas para restaurar las conexiones migradas a orígenes externos. Para ello, abra la conexión e introduzca la contraseña.

• Cuando las particiones existen entre los cubos que se van a migrar, deberá importar el origen de datos antes que el destino de datos. De lo contrario, las definiciones de partición no se pueden restaurar.

  Las operaciones de importación de Lifecycle Management (LCM) (y de importación de la utilidad de migración) no están soportadas para migrar particiones federadas. Las particiones federadas se deben volver a crear manualmente en el destino.

• La importación de LCM no migra las credenciales de alias de ubicación. Debe sustituir las credenciales de alias de ubicación, ya sea volviendo a crear alias de ubicación mediante MaxL o editando las credenciales de alias de ubicación en el XML exportado mediante la Exportación de LCM.

Ejemplo

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

Sintaxis

listapp [-verbose] [-details]

Ejemplo

esscs listapp -v -dtl

Sintaxis

listdb [-verbose] -application applicationName [details]

Ejemplo

esscs listdb -v -a Sample -dtl

Los artefactos del cubo pueden incluir archivos de datos, libros de trabajo, archivos de reglas, archivos de scripts de cálculo u otros artefactos. Los artefactos del cubo incluyen cualquier archivo necesario para realizar acciones en aplicaciones y cubos.

Para mostrar los archivos de un cubo, necesita al menos el permiso de acceso a base de datos para la aplicación. No se requieren permisos especiales para mostrar los archivos de su directorio de usuario.

Sintaxis

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

Ejemplos

esscs listfiles -t rul -a Sample -d Basic 

esscs listfiles -CP "/shared"

También puede gestionar archivos en el diseñador de cubos, la interfaz web de Essbase o la API de REST.

Sintaxis

listfilters [-verbose] -application appname -db cubename 

Ejemplo

esscs listfilters -v -a Sample -d Basic 

Sintaxis

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

Ejemplo

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

Sintaxis

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

Ejemplos

Nivel de cubo

esscs listvariables -a Sample -db Basic

Nivel de aplicación

esscs listvariables -a Sample

Nivel global

esscs listvariables

Sintaxis

 setpassword [-verbose] -essbaseurl URL -user userName

Notas

Después de migrar a la versión 21.4 o superior, deberá restablecer las contraseñas almacenadas que se hayan guardado mediante este comando en una versión anterior.

Ejemplo

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

Sintaxis

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

Ejemplo

esscs start -v -a Sample -d Basic

Sintaxis

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

Ejemplo

esscs stop -v -a Sample -d Basic 

Sintaxis

unsetpassword [-verbose] -essbaseurl URL -user userName

Ejemplo

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

Para realizar tareas tales como cargas de datos, creación de dimensiones, cálculos u otras operaciones, puede que necesite cargar archivos de datos, de reglas, de scripts de cálculo u otro tipo de artefactos en el directorio del cubo. Además, puede cargar los artefactos en el directorio de usuario.

Para cargar archivos en un cubo, necesita tener, al menos, el permiso de gestor de bases de datos. No se necesita ningún permiso especial para cargar en el directorio de usuario.

Sintaxis

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

-ca gzip

-ca lz4

Ejemplos

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

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

También puede gestionar archivos en el diseñador de cubos, la interfaz web de Essbase o la API de REST.

Sintaxis

version

Ejemplo

esscs version