Referência do Comando da CLI

Para poder emitir quaisquer comandos da CLI para o Essbase, deve entrar em sessão. Se for necessária uma ligação restrita, o URL deverá começar por https.

Pode autenticar das seguintes formas utilizando a CLI:

• Utilize setpassword uma vez para gravar a senha para a sua combinação de cliente/utilizador. Nas sessões subsequentes, pode utilizar o comando login sem que lhe seja solicitada a introdução de uma senha.
• Utilize as opções -user e -password com o comando login (Atenção: a senha aparece na janela da shell como texto simples).
• Utilize apenas a opção -user com o comando login. É-lhe solicitado que introduza a senha, que fica oculta.

Se for um utilizador SSO federado no Oracle Identity Cloud Service, a entrada em sessão utilizando MaxL ou CLI não é suportada. A entrada em sessão SSO federada requer uma janela de browser. Crie um utilizador nativo do Identity Cloud Service e utilize-o em vez de entrar em sessão utilizando MaxL ou CLI.

Sintaxe (login)

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

Exemplo 1 (login)

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

Exemplo 2 (login)

No exemplo seguinte, o utilizador a entrar em sessão, admin1@example.com é um administrador do Identity Cloud Service que foi definido como o administrador inicial do Essbase durante a implementação da pilha do Essbase no Oracle Cloud Infrastructure. Uma vez que a senha não é introduzida neste exemplo, será solicitado ao administrador para a fornecer de seguida . O URL é o essbase_url das saídas da tarefa resultantes da pilha implementação.

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

Sintaxe (logout)

logout

Exemplo (logout)

esscs logout

Antes de executar scripts de cálculo, primeiro deve carregar os scripts, tais como ficheiros .csc, para o diretório do cubo. Pode utilizar a CLI para carregar ficheiros. Consulte Upload: Acrescentar Ficheiros do Cubo.

Sintaxe

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

Exemplo

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

Também pode executar os scripts de cálculo utilizando a opção Calcular no Cube Designer ou no Smart View, Tarefas na interface da Web do Essbase ou API REST, ou executar cálculo em 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])}" 

Também pode limpar os dados utilizando a opção Carregar Dados no Cube Designer, Tarefas na interface da Web do Essbase ou API REST, ou alterar reposição da base de dados DBS-NAME em MaxL.

Descrição

Um administrador de serviço deve utilizar este comando para criar e gravar a ligação local antes de alguém utilizar os comandos da CLI dataload ou dimbuild com a opção de transmissão em fluxo. Também deve definir uma variável de ambiente EXTERNAL_CLASSPATH de modo a apontar para o ficheiro .jar do driver da base de dados (consulte Criar Dimensões e Carregar Dados através da Transmissão em Fluxo de uma Base de Dados Remota).

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 tiver conectividade de rede entre uma origem externa de dados e o Essbase, é aconselhável definir ligações globais ou de nível de aplicação e Origens de Dados na interface da Web do Essbase. Estas definições ajudam-no a efetuar o "pull" facilmente dos dados a partir da origem externa. Se não tiver conectividade de rede entre o Essbase e a origem externa de dados, pode transmitir carregamentos de dados ou criações de dimensões utilizando a ferramenta CLI, primeiro utilizando este comando para criar uma ligação local e, em seguida, emitindo o comando dataload ou dimbuild com a opção de transmissão.

Notas

Depois de migrar para a Release 21.4 ou superior, o Administrador do Serviço precisa de recriar as ligações locais gravadas que foram criadas utilizando este comando numa release anterior.

Exemplos

Este comando requer um dos seguintes conjuntos de dados:

• Ficheiro de dados e ficheiro de regras opcional

• Ficheiro de regras com nome de utilizador e senha

• Opção de transmissão em fluxo a referenciar uma ligação local gravada

A base de dados de origem deve estar acessível na rede de cliente, visto que nem todos os drivers da base de dados podem funcionar com proxies Java.

Para carregar dados, primeiro deve carregar os ficheiros de regras e de carregamento de dados para o diretório do cubo. Pode utilizar a CLI para carregar ficheiros. Consulte Upload: Acrescentar Ficheiros do 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"

Também pode carregar dados utilizando o Cube Designer, Tarefas na interface web do Essbase ou API REST, ou importar dados em 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 pode gerir ficheiros no Cube Designer, interface da Web do Essbase ou 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

Também pode implementar cubos utilizando o Cube Designer ou utilizando a opção Importar na secção Aplicações da interface da Web do Essbase.

Antes de carregar dimensões, deve primeiro carregar os ficheiros de criação de dimensões e de regras para o Essbase. Pode utilizar a CLI para carregar ficheiros. Consulte Upload: Acrescentar Ficheiros do 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

Também pode carregar dimensões utilizando o Cube Designer, Tarefas na interface web do Essbase ou API REST, ou importar dimensões em MaxL.

Pode ter de descarregar ficheiros de texto, ficheiros de regras ou ficheiros de script de cálculo a partir de um cubo, para poder trabalhar neles ou carregá-los para outro cubo. Para descarregar artefactos de cubos, é necessário, pelo menos, a permissão de Atualização da Base 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 pode gerir ficheiros no Cube Designer, interface da Web do Essbase ou 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

Notas

Este comando, tal como outros comandos da CLI, pode ser utilizado externamente ao computador do Essbase, enquanto o utilitário LCM deve ser executado no computador do Essbase.

Exemplo

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

Exemplo de Script do Windows

O seguinte script do Windows, lcmexportall.bat, exporta todas as aplicações para o diretório local atual a partir 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

Notas

• Este comando, tal como outros comandos da CLI, pode ser utilizado externamente ao computador do Essbase, enquanto o utilitário de LCM deve ser executado no computador do Essbase.

• Depois da conclusão da importação do LCM, poderá precisar de executar mais ações para repor ligações migradas para origens externas. Para tal, abra a ligação e introduza a senha.

• Quando existem partições entre cubos que estão a ser migrados, é necessário importar a origem de dados antes do destino de dados. Caso contrário, as definições de partição podem não ser repostas.

  As operações de importação do Lifecycle Management (LCM) (e a importação do Utilitário de Migração) não são suportadas para a migração de partições federadas. As partições federadas devem ser recriadas manualmente no destino.

• A Importação de LCM não migra as credenciais de pseudónimos da localização. Deve substituir as suas credenciais de pseudónimos da localização ao recriar os pseudónimos da localização utilizando MaxL ou ao editar as credenciais de pseudónimos da localização no XML exportado pela Exportação de 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 artefactos do cubo podem incluir ficheiros de dados, livros, ficheiros de regras, ficheiros de script de cálculo ou outros artefactos. Os artefactos do cubo incluem quaisquer ficheiros necessários para efetuar ações nas aplicações e cubos.

Para listar os ficheiros de um cubo, é necessário, pelo menos, a permissão de Acesso à Base de Dados para a aplicação. Não são necessárias permissões especiais para listar os ficheiros do seu diretório do utilizador.

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 pode gerir ficheiros no Cube Designer, interface da Web do Essbase ou 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 de cubo

esscs listvariables -a Sample -db Basic

Nível da aplicação

esscs listvariables -a Sample

Nível global

esscs listvariables

Sintaxe

 setpassword [-verbose] -essbaseurl URL -user userName

Notas

Depois de migrar para a Release 21.4 ou superior, deve redefinir as senhas armazenadas que foram gravadas utilizando este comando numa 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 efetuar tarefas como carregamentos de dados, criações de dimensões, cálculos ou outras operações, poderá ser necessário carregar ficheiros de dados, ficheiros de regras, ficheiros de script de cálculo ou outros artefactos para o diretório do cubo. Também pode carregar os artefactos para o seu diretório do utilizador.

Para carregar ficheiros para um cubo, é necessário, pelo menos, a permissão de Gestor da Base de Dados. Não são necessárias permissões especiais para carregar para o seu diretório do utilizador.

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 pode gerir ficheiros no Cube Designer, interface da Web do Essbase ou API REST.

Sintaxe

version

Exemplo

esscs version