Справка по интерфейсу командной строки

Чтобы выполнять другие команды интерфейса командной строки в Essbase, необходимо войти в систему. Если требуется защищенное подключение, URL-адрес должен начинаться с https.

С помощью интерфейса командной строки можно выполнить аутентификацию указанными ниже способами.

• Используйте setpassword один раз, чтобы сохранить пароль для комбинации клиент-пользователь. В последующих сеансах можно использовать команду login без запроса на ввод пароля.
• Используйте параметры -user и -password с командой login (Внимание! Пароль отображается в окне оболочки в виде явного текста).
• Используйте только параметр -user с командой login. Появится запрос на ввод пароля, который будет скрыт.

Для федерированных пользователей SSO в Oracle Identity Cloud Service вход с помощью MaxL или CLI не поддерживается. Для входа на основе федерированного единого входа требуется окно браузера. Создайте собственного пользователя Identity Cloud Service и используйте его для входа с помощью MaxL или CLI.

Синтаксис (вход)

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

Пример 1 (вход)

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

Пример 2 (вход)

В следующем примере входящий в систему пользователь Admin1@example.com — это администратор Identity Cloud Service, который был установлен в качестве первоначального администратора Essbase при развертывании стека Essbase в Oracle Cloud Infrastructure. Так как пароль в этом примере не введен, администратору будет предложено ввести его позднее. URL-адрес соответствует значению essbase_url из выходных данных задания, полученных из развертывания стека.

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

Синтаксис (выход)

logout

Пример (выход)

esscs logout

Чтобы выполнить сценарии расчета, необходимо сначала загрузить эти сценарии в виде файлов .csc в каталог куба. Загрузить файлы можно с помощью CLI. См. раздел "Upload: добавление файлов куба".

Синтаксис

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

Пример

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

Кроме того, сценарии расчета можно выполнить с помощью элемента "Рассчитать" в конструкторе кубов или Smart View, а также заданий в веб-интерфейсе Essbase или REST API или команды execute calculation в MaxL.

Синтаксис

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

Пример

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

Данные можно также очистить с помощью команды "Загрузить данные" в конструкторе кубов, заданий в веб-интерфейсе Essbase, API-интерфейса REST или команды alter database DBS-NAME reset в MaxL.

Описание

Администратор сервиса должен использовать эту команду для создания и сохранения локального подключения, прежде чем любой пользователь сможет использовать команды интерфейса командной строки dataload или dimbuild с функцией потоковой передачи. Также необходимо задать переменную окружения EXTERNAL_CLASSPATH, чтобы указать файл .jar для драйвера базы данных (см. Построение измерений и загрузка данных путем потоковой передачи из удаленной базы данных).

Синтаксис

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

При наличии сетевого соединения между внешним источником данных и Essbase наиболее эффективно определить глобальные подключения или подключения на уровне приложений и источники данных в веб-интерфейсе Essbase. Такие определения облегчают "извлечение" данных из внешнего источника. Если сетевое соединение между Essbase и внешним источником данных отсутствует, можно выполнить потоковую загрузку данных или построение измерений с помощью интерфейса командной строки, сначала создав локальное подключение с помощью этой команды, а затем выполнив команду dataload или dimbuild с параметром stream.

Примечания

После перехода на версию 21.4 или более позднюю администратору сервиса необходимо заново создать все сохраненные локальные подключения, созданные с помощью этой команды в предыдущей версии.

Примеры

Для этой команды требуется один из указанных ниже наборов параметров.

• файл данных и необязательный файл правил

• файл правил с именем пользователя и паролем

• параметр stream, ссылающийся на сохраненное локальное подключение

Исходная база данных должна быть доступна в клиентской сети, так как не все драйверы баз данных могут работать с прокси-серверами Java.

Чтобы загрузить данные, сначала необходимо загрузить в каталог куба файлы загрузки данных и файлы правил. Загрузить файлы можно с помощью CLI. См. Upload: добавление файлов куба.

Синтаксис

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]

Примеры

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"

Данные также можно загружать с помощью конструктора кубов, заданий в веб-интерфейсе Essbase, API-интерфейса REST или команды import data в MaxL.

Синтаксис

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

Примеры

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

esscs deletefile -CF /shared/Data.txt

Можно также управлять файлами в конструкторе кубов, веб-интерфейсе Essbase или API-интерфейсе REST.

Синтаксис

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

Примеры

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

Кроме того, можно развернуть кубы с помощью конструктора кубов или функции "Импорт" в разделе Приложения веб-интерфейса Essbase.

Прежде чем загружать измерения, необходимо сначала загрузить файлы построения измерений и файлы правил в Essbase. Загрузить файлы можно с помощью CLI. См. раздел "Upload: добавление файлов куба".

Синтаксис

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]

Примеры

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

Измерения также можно загружать с помощью конструктора кубов, заданий в веб-интерфейсе Essbase, API-интерфейса REST или команды import dimensions в MaxL.

Иногда требуется выгрузить из куба текстовые файлы, файлы правил или файлы сценариев расчета, чтобы работать с ними или загрузить их в другой куб. Чтобы выгрузить артефакты куба, необходимо, как минимум, разрешение "Обновление баз данных".

Синтаксис

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

Примеры

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

Можно также управлять файлами в конструкторе кубов, веб-интерфейсе Essbase или API-интерфейсе REST.

Синтаксис

[command] -help | -h

Примеры

esscs -help

esscs -h

esscs dataload -help

Синтаксис

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

Примечания

Так же, как и другие команды CLI, данную команду можно использовать вне машины Essbase, а служебную программу LCM необходимо запускать только на машине Essbase.

Пример

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

Пример сценария Windows

Представленный ниже сценарий Windows lcmexportall.bat экспортирует все приложения в текущий локальный каталог, из которого был вызван интерфейс командной строки.

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

Примечания

• Так же, как и другие команды CLI, данную команду можно использовать вне машины Essbase, а служебную программу LCM необходимо запускать только на машине Essbase.

• После завершения импорта LCM может потребоваться выполнить дальнейшие действия по восстановлению перенесенных подключений для внешних источников. Для этого откройте подключение и введите пароль.

• Если секции существуют между переносимыми кубами, необходимо импортировать сначала источник данных, а затем адресат данных. В противном случае восстановить определения секции удается не всегда.

  Операции импорта управления жизненным циклом (LCM) (и средство миграции) не поддерживаются для миграции федерированных разделов. Федерированные разделы необходимо повторно создать вручную в целевом расположении.

• При импорте LCM не переносятся учетные данные псевдонима расположения. Необходимо заменить учетные данные псевдонима расположения, либо заново создав псевдонимы расположения с помощью MaxL, либо отредактировав учетные данные псевдонима расположения в файле XML, экспортированном с помощью функции экспорта LCM.

Пример

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

Синтаксис

listapp [-verbose] [-details]

Пример

esscs listapp -v -dtl

Синтаксис

listdb [-verbose] -application applicationName [details]

Пример

esscs listdb -v -a Sample -dtl

Артефакты куба могут включать в себя файлы данных, рабочие книги, файлы сценариев расчета или другие артефакты. Артефакты куба включают файлы, необходимые для выполнения действий с приложениями и кубами.

Чтобы отобразить список файлов для куба, требуется по меньшей мере разрешение "Доступ к базам данных" для приложения. Для вывода списка файлов из своего каталога пользователя специальные разрешения не требуются.

Синтаксис

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

Примеры

esscs listfiles -t rul -a Sample -d Basic 

esscs listfiles -CP "/shared"

Можно также управлять файлами в конструкторе кубов, веб-интерфейсе Essbase или API-интерфейсе REST.

Синтаксис

listfilters [-verbose] -application appname -db cubename 

Пример

esscs listfilters -v -a Sample -d Basic 

Синтаксис

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

Пример

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

Синтаксис

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

Примеры

Уровень куба

esscs listvariables -a Sample -db Basic

Уровень приложения

esscs listvariables -a Sample

Глобальный уровень

esscs listvariables

Синтаксис

 setpassword [-verbose] -essbaseurl URL -user userName

Примечания

После перехода на версию 21.4 или более позднюю необходимо сбросить все пароли, сохраненные с помощью этой команды в предыдущей версии.

Пример

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

Синтаксис

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

Пример

esscs start -v -a Sample -d Basic

Синтаксис

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

Пример

esscs stop -v -a Sample -d Basic 

Синтаксис

unsetpassword [-verbose] -essbaseurl URL -user userName

Пример

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

Для выполнения таких задач, как загрузка данных, построение измерений, расчеты и других, иногда требуется загрузить в каталог куба файлы данных, файлы правил, файлы сценариев расчета или другие артефакты. Также можно загрузить артефакты в свой каталог пользователя.

Чтобы загрузить файлы в куб, требуется по меньшей мере разрешение "Менеджер баз данных". Для загрузки в свой каталог пользователя специальные разрешения не требуются.

Синтаксис

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

-ca gzip

-ca lz4

Примеры

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

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

Можно также управлять файлами в конструкторе кубов, веб-интерфейсе Essbase или API-интерфейсе REST.

Синтаксис

version

Пример

esscs version