Referência do Comando CLI

Para poder emitir quaisquer outros comandos da CLI para o Essbase, faça log-in. Se for necessária uma conexão segura, a URL deverá começar com https.

Você pode autenticar das seguintes maneiras usando a CLI:

• Use setpassword uma vez para armazenar a senha na combinação cliente/usuário. Nas sessões subsequentes, você poderá usar o comando login sem ser solicitado a digitar uma senha.
• Use as opções -user e -password com o comando login (Cuidado: a senha aparece na janela do shell como tempo limpo).
• Só use a opção -user com o comando login. Você será solicitado a digitar a senha, que fica oculta.

Se for um usuário de SSO federado no Oracle Identity Cloud Service, não poderá fazer log-in usando MaxL ou CLI. O log-in de SSO federado requer uma janela do browser. Crie um usuário nativo do Identity Cloud Service e use, em vez de fazer log-in usando MaxL ou CLI.

Sintaxe (log-in)

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

Exemplo 1 (log-in)

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

Exemplo 2 (log-in)

No exemplo a seguir, o usuário que está fazendo log-in, admin1@example.com é um administrador do Identity Cloud Service que foi definido como o administrador do Essbase inicial durante a implantação da pilha do Essbase no Oracle Cloud Infrastructure. Como a senha não é inserida neste exemplo, será solicitado que o administrador a forneça a seguir. O URL é o essbase_url das saídas do job resultantes da implantação da pilha.

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

Sintaxe (log-out)

logout

Exemplo (log-out)

esscs logout

Antes de executar scripts de cálculo, primeiro faça upload dos scripts, como arquivos .csc, para o diretório de cubo. Você pode usar a CLI para fazer upload de arquivos. Consulte Upload: Adicionar Arquivos de Cubo.

Sintaxe

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

Exemplo

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

Você também pode executar scripts de cálculo usando a opção Calcular no Cube Designer ou Smart View, Jobs na Interface Web do Essbase ou API REST, ou executar cálculo no MaxL.

Sintaxe

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

Exemplo

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

Você também pode limpar os dados usando a opção Carregar Dados no Cube Designer, Jobs na interface Web do Essbase ou API REST ou alterar o banco de dados DBS-NAME redefinir no MaxL.

Descrição

Um administrador de serviço deve usar esse comando para criar e salvar a conexão local, antes que alguém use os comandos dataload ou dimbuild com a opção de streaming. Defina também uma variável de ambiente EXTERNAL_CLASSPATH para indicar o arquivo .jar para o seu driver de banco de dados (consulte Criar Dimensões e Carregar Dados por Streaming com Base em um Banco de Dados Remoto).

Sintaxe

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

Se você possui conectividade de rede entre uma origem externa de dados e o Essbase, é mais eficiente definir conexões e origens de dados globais ou no nível do aplicativo na Interface Web do Essbase. Essas definições o ajudam a "extrair" dados facilmente da origem externa. Se não houver conectividade de rede entre o Essbase e a origem externa de dados, você deverá transmitir as cargas de dados ou criações de dimensões usando a CLI, primeiro usando este comando para criar uma conexão local e depois emitindo o comando dataload ou dimbuild com a opção de stream.

Observações

Após a migração para a Release 21.4 ou posterior, o Administrador de Serviço precisa recriar todas as conexões locais salvas que foram criadas usando este comando em uma release anterior.

Exemplos

Este comando requer um dos seguintes conjuntos de opções:

• Arquivo de dados e arquivo de regra opcional

• Arquivo de regra com nome de usuário e senha

• Opção de streaming que faz referência a uma conexão local salva

O banco de dados de origem deve estar acessível na rede do cliente, pois nem todos os drivers de banco de dados podem trabalhar com proxies Java.

Para carregar dados, primeiro faça upload dos arquivos de carregamento de dados e de regra para o diretório de cubo. Você pode usar a CLI para fazer upload de arquivos. Consulte Upload: Adicionar Arquivos de Cubo.

Sintaxe

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]

Exemplos

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"

Você também pode carregar os dados usando Cube Designer, Jobs na interface web do Essbase, API REST ou importar dados no MaxL.

Sintaxe

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

Exemplos

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

esscs deletefile -CF /shared/Data.txt

Também é possível gerenciar arquivos no Cube Designer, na Interface Web do Essbase ou na API REST.

Sintaxe

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

Exemplos

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

Você também pode implantar cubos usando o Cube Designer ou usando a opção Importar na seção Aplicativos da Interface Web do Essbase.

Antes de carregar as dimensões, primeiro faça upload dos arquivos de regra e criação de dimensão para o Essbase. Você pode usar a CLI para fazer upload de arquivos. Consulte Upload: Adicionar Arquivos de Cubo.

Sintaxe

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]

Exemplos

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

Você também pode carregar dimensões usando Cube Designer, Jobs na interface web do Essbase, API REST ou importar dimensões no MaxL.

Talvez seja necessário fazer download de arquivos de texto, arquivos de regra ou arquivos de script de cálculo de um cubo, para que você possa trabalhar neles ou fazer upload deles para outro cubo. Para fazer download de artefatos do cubo é necessário, pelo menos, da permissão de Atualização do Banco de Dados.

Sintaxe

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

Exemplos

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

Também é possível gerenciar arquivos no Cube Designer, na Interface Web do Essbase ou na API REST.

Sintaxe

[command] -help | -h

Exemplos

esscs -help

esscs -h

esscs dataload -help

Sintaxe

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

Observações

Este comando, assim como outros da CLI, pode ser usado fora da máquina Essbase, enquanto o utilitário LCM deve ser executado na máquina Essbase.

Exemplo

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

Exemplo de Script do Windows

O script do Windows a seguir, lcmexportall.bat, exporta todos os aplicativos para o diretório local atual do qual a CLI foi chamada.

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

Sintaxe

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

Observações

• Este comando, assim como outros da CLI, pode ser usado fora da máquina Essbase, enquanto o utilitário LCM deve ser executado na máquina Essbase.

• Após a conclusão da importação do LCM, talvez seja necessário realizar outras ações para restaurar as conexões migradas para origens externas. Para fazer isso, abra a conexão e digite a senha.

• Quando houver partições entre os cubos que estão sendo migrados, importe a origem de dados antes do destino dos dados. Caso contrário, as definições de partição poderão não ser restauradas.

  As operações de importação do Gerenciamento de Ciclo de Vida (LCM), bem como a importação do Utilitário de Migração, não são suportadas para migração de partições federadas. As partições federadas devem ser recriadas manualmente no destino.

• A Importação do LCM não migra as credenciais do alias de localização. Substitua suas credenciais do alias de localização, seja recriando os aliases de localização usando o MaxL ou editando as credenciais do alias de localização no XML exportado pela Exportação do LCM.

Exemplo

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

Sintaxe

listapp [-verbose] [-details]

Exemplo

esscs listapp -v -dtl

Sintaxe

listdb [-verbose] -application applicationName [details]

Exemplo

esscs listdb -v -a Sample -dtl

Os artefatos do cubo podem incluir arquivos de dados, pastas de trabalho, arquivos de regra, arquivos de script de cálculo ou outros artefatos. Os artefatos do cubo incluem todos os arquivos necessários para executar ações em aplicativos e cubos.

Para listar os arquivos de um cubo, você precisa ter pelo menos a permissão de Acesso ao Banco de Dados do aplicativo. Nenhuma permissão especial é necessária para listar os arquivos de seu diretório de usuário.

Sintaxe

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

Exemplos

esscs listfiles -t rul -a Sample -d Basic 

esscs listfiles -CP "/shared"

Também é possível gerenciar arquivos no Cube Designer, na Interface Web do Essbase ou na API REST.

Sintaxe

listfilters [-verbose] -application appname -db cubename 

Exemplo

esscs listfilters -v -a Sample -d Basic 

Sintaxe

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

Exemplo

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

Sintaxe

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

Exemplos

Nível do cubo

esscs listvariables -a Sample -db Basic

Nível do aplicativo

esscs listvariables -a Sample

Nível global

esscs listvariables

Sintaxe

 setpassword [-verbose] -essbaseurl URL -user userName

Observações

Após a migração para a Release 21.4 ou posterior, redefina todas as senhas armazenadas que foram salvas usando esse comando em uma release anterior.

Exemplo

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

Sintaxe

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

Exemplo

esscs start -v -a Sample -d Basic

Sintaxe

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

Exemplo

esscs stop -v -a Sample -d Basic 

Sintaxe

unsetpassword [-verbose] -essbaseurl URL -user userName

Exemplo

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

Para executar tarefas como carregamentos de dados, criações de dimensões, cálculos ou outras operações, talvez seja necessário fazer upload de arquivos de dados, arquivos de regra, arquivos de script de cálculo ou outros artefatos para o diretório de cubo. Você também pode fazer upload dos artefatos para seu diretório de usuário.

Para fazer upload de arquivos para um cubo, você precisa ter pelo menos a permissão de Gerente de Banco de Dados. Nenhuma permissão especial é necessária para fazer upload para seu diretório de usuário.

Sintaxe

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

-ca gzip

-ca lz4

Exemplos

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

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

Também é possível gerenciar arquivos no Cube Designer, na Interface Web do Essbase ou na API REST.

Sintaxe

version

Exemplo

esscs version