|
Os tipos de arquivos clássicos não estarão mais disponíveis para uso a partir de janeiro de 2021. Você pode fazer a transição de seus arquivos clássicos ou baixar um PDF. Saber mais

Centro de suporte da Workiva

Comandos do Oracle Essbase

Comandos do Oracle Essbase

  • Última atualização em

Para gerenciar cubos do Oracle Essbase® no local como parte de uma cadeia, adicione uma etapa que inclua um comando de conexão do Oracle Essbase. Por exemplo:

  • Carregar e extrair dados
  • Executar cálculos
  • Gerenciar configurações do sistema
Aviso de compatibilidade: A Workiva testou e validou esse conector exclusivamente com as versões 11.1.2.2.x, 11.1.2.3, 11.1.2.4 e 11.2. A Workiva não pode garantir que esse conector funcionará como desejado com versões não testadas.

Para habilitar esses comandos, primeiro um administrador de TI cria um conector do Oracle Essbase.

Exportação de ASO/BSO para tabular

Para exportar dados da opção de armazenamento agregado (ASO) ou da opção de armazenamento em bloco (BSO) para um arquivo tabular, adicione um comando ASO/BSO export to tabular.

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.
Banco de dados Digite o banco de dados do Essbase a ser exportado.
Nome do arquivo de exportação Digite o caminho absoluto do arquivo de dados no servidor Essbase a ser exportado.
Nível de dados Para dados BSO, selecione se você deseja exportar todos os dados ou somente os dados de Nível 1 ou de entrada.
Headers Para incluir uma linha de cabeçalho na saída tabular, liste os cabeçalhos das colunas.
Usar colunas Para usar colunas na exportação tabular, marque essa caixa.

Saídas

Saída Tipo de saída
Arquivo tabular Arquivo

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Limpar dados

Para limpar os dados de um determinado banco de dados, adicione um comando Clear data.

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.
Banco de dados Digite o banco de dados do Essbase do qual você deseja limpar os dados.
Dados a serem limpos Selecione se você deseja limpar todos os dados ou apenas os parciais.
Limpar expressão de dados Se Data to clear for Partial, digite a expressão multidimensional (MDX) para especificar a região a ser limpa.

Saídas

Nenhum

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Copiar aplicativo

Para criar uma cópia de um aplicativo, adicione um comando Copy application.

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.
Aplicativo de destino Digite o nome do novo aplicativo a ser criado.

Saídas

Nenhum

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Copiar banco de dados

Para criar uma cópia de um banco de dados, adicione o comando Copy database.

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.
Banco de dados Digite o nome do banco de dados do Essbase a ser copiado.
Aplicativo de destino Digite o nome do novo aplicativo no qual você criará o novo banco de dados.
Banco de dados de destino Digite o nome do novo banco de dados a ser criado a partir da cópia.

Saídas

Nenhum

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Acesso ao banco de dados

Para conceder privilégios de acesso a um grupo de usuários em um banco de dados, adicione um comando Database access.

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.
Banco de dados Digite o nome do banco de dados do Essbase ao qual você deseja conceder acesso.
Grupo de usuários Digite o nome do grupo de usuários para acessar o banco de dados.
Tipo de acesso Selecione o tipo de acesso a ser concedido.

Saídas

Nenhum

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Informações sobre o banco de dados

Para recuperar informações e consultas recentes do banco de dados, adicione um comando Database info.

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.
Banco de dados Digite o nome do banco de dados do Essbase do qual você deseja obter informações.

Saídas

Nenhum

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Excluir arquivo

Para excluir um arquivo no servidor, adicione um comando Delete file.

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.
Banco de dados Digite o nome do banco de dados do Essbase do qual você deseja excluir o arquivo.
Arquivo Digite o nome do arquivo a ser excluído.

Saídas

Nenhum

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Exibir sessão

Para recuperar informações sobre a sessão atual, adicione um comando Display session.

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.
Banco de dados Digite o nome do banco de dados do Essbase para recuperar as informações da sessão.

Saídas

Nenhum

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Baixar arquivo

Para fazer download de um arquivo do servidor, adicione o comando Download file.

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.
Banco de dados Digite o nome do banco de dados do Essbase do qual você deseja fazer o download do arquivo.
Arquivo Digite o nome do arquivo a ser baixado.

Saídas

Saída Tipo de saída
Arquivo de download do Essbase Arquivo

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Drop lock

Para remover um bloqueio de um determinado banco de dados, adicione um comando Drop lock.

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.
Banco de dados Digite o nome do banco de dados do Essbase do qual você deseja remover o bloqueio.

Saídas

Nenhum

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Executar script de cálculo

Para executar um script de cálculo a partir de um arquivo ou texto, adicione um comando Executar script de cálculo.

Dica: Para executar um script grande, forneça-o como um arquivo. Por exemplo, faça o upload como um recurso de espaço de trabalho ou selecione a saída de um comando Handlebars anteriormente na cadeia.

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.
Banco de dados Digite o nome do banco de dados do Essbase.
Arquivo de script Selecione o arquivo de script a ser executado. Como alternativa, digite o script como texto em Texto do script.
Texto do script Digite o texto do script de cálculo a ser executado. Como alternativa, insira o script como um arquivo em Arquivo de script.

Saídas

Saída Tipo de saída
Saída do script Calc Arquivo

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Executar MaxL

Para executar um script MaxL, adicione um comando Execute MaxL Script.

A Oracle removeu o suporte a esse comando na versão 12.2.1.0. Se você usar esse comando com o Essbase versão 12.2.1.0 ou posterior, o comando poderá falhar e fazer com que sua cadeia pare. Antes de usar esse comando, verifique se a versão do Oracle Essbase que você possui é compatível. (Consulte Oracle® Essbase Readme Release 12.2.1.0.0 (2016).)

Propriedades

Propriedade Detalhes
Arquivo de script Selecione o arquivo de script MaxL a ser executado. Como alternativa, digite o script como texto em Texto do script.
Texto do script Digite o texto do script MaxL a ser executado. Como alternativa, insira o script como um arquivo em Arquivo de script.

Saídas

Saída Tipo de saída
Saída do script MaxL Arquivo

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Executar script de relatório

Para executar um script de relatório como um arquivo ou texto, adicione um comando Execute report script. 

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.
Banco de dados Digite o nome do banco de dados do Essbase.
Arquivo de script de relatório Selecione o arquivo de script de relatório a ser executado. Como alternativa, digite o script como texto em Texto do script. 
Texto do script Digite o texto do script do relatório a ser executado. Como alternativa, insira o script como um arquivo em Arquivo de script de relatório.

Saídas

Saída Tipo de saída
Saída de script de relatório Arquivo

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Exportar dados

Para exportar dados de um determinado banco de dados, adicione um comando Exportar dados.

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.
Banco de dados Digite o nome do banco de dados do Essbase.
Nome do arquivo de exportação Digite o nome do arquivo para o qual você deseja exportar os dados.
Nível de dados Selecione o nível de dados a serem exportados.
Usar colunas Para usar colunas na exportação de dados, marque essa caixa.

Saídas

Saída Tipo de saída
Nome do arquivo de dados de exportação String

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Conceder execução

Para conceder a um usuário privilégios de execução para um determinado cálculo, adicione um comando Grant execute.

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.
Banco de dados Digite o nome do banco de dados do Essbase.
Nome do cálculo Digite o nome do cálculo ao qual você deseja conceder acesso.
Usuário de acesso Digite o nome de usuário para acessar o cálculo.

Saídas

Nenhum

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Listar aplicativos

Para listar os aplicativos disponíveis no servidor Essbase, adicione um comando Listar aplicativos.

Propriedades

Nenhum

Saídas

Saída Tipo de saída
Aplicativos do Essbase Matriz

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Listar bancos de dados

Para listar os bancos de dados disponíveis para um determinado aplicativo, adicione um comando Listar bancos de dados.

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.

Saídas

Saída Tipo de saída
Bancos de dados Essbase Matriz

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Listar arquivos

Para listar os arquivos de um determinado aplicativo ou banco de dados, adicione o comando List files.

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.
Banco de dados Digite o nome do banco de dados do Essbase.
Tipo de arquivo Selecione o tipo de arquivo a ser pesquisado.
Filtro Para refinar ainda mais os resultados, filtre usando a sintaxe glob, como list* para arquivos que começam com "list".

Saídas

Saída Tipo de saída
Arquivos Essbase Matriz
Arquivos Essbase CSV Arquivo

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Filtros de lista

Para listar os filtros de um determinado aplicativo e banco de dados, adicione um comando List filters.

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.
Banco de dados Digite o nome do banco de dados do Essbase.

Saídas

Saída Tipo de saída
Filtros do Essbase Matriz

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Listar bloqueios

Para listar os bloqueios de um determinado aplicativo e banco de dados, adicione um comando List locks.

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.
Banco de dados Digite o nome do banco de dados do Essbase.

Saídas

Saída Tipo de saída
Bloqueios do Essbase Matriz

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Listar variáveis

Para listar as variáveis de um determinado aplicativo ou banco de dados, adicione o comando Listar variáveis.

Propriedades

Propriedade Detalhes
Localização da variável Selecione se a variável está definida no nível do aplicativo, do banco de dados ou global.
Aplicação Se Local da variável for Aplicativo ou Banco de dados, digite o nome do aplicativo Essbase.
Banco de dados Se Local da variável for Database (Banco de dados), digite o nome do banco de dados do Essbase.

Saídas

Saída Tipo de saída
Variáveis do Essbase Matriz

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Carregar dados do arquivo

Para carregar dados de um arquivo no servidor, adicione um comando Carregar dados do arquivo.

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.
Banco de dados Digite o nome do banco de dados do Essbase.
Arquivo de dados Digite o nome do arquivo de dados no servidor a ser carregado.
Arquivo de regra Digite o arquivo de regras para carregar dados. Opcional se os dados puderem ser carregados no estado em que se encontram.
Abortar com erro Para cancelar uma operação por erro, marque essa caixa.

Saídas

Nenhum

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Carregar dados do SQL

Para carregar dados de uma fonte SQL, adicione um comando Carregar dados do SQL.

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.
Banco de dados Digite o nome do banco de dados do Essbase.
Arquivo de regras Digite o nome do arquivo de regras no servidor OLAP. Por exemplo, para o arquivo de regras Data.rul no diretório app/cube do servidor OLAP, digite Data.
Abortar com erro Para cancelar uma operação por erro, marque essa caixa.
Nome de usuário externo Digite o nome de usuário de uma fonte externa de carregamento de dados.
Senha externa Digite a senha de uma fonte externa de carregamento de dados.

Saídas

Nenhum

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Carregar metadados

Para carregar metadados de um arquivo no servidor, adicione um comando Load metadata.

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.
Banco de dados Digite o nome do banco de dados do Essbase.
Arquivo de dados Digite o nome do arquivo de dados no servidor a ser carregado.
Arquivo de regras Digite o nome do arquivo de regras para carregar dados. Opcional se os dados puderem ser carregados no estado em que se encontram.
Forçar Para forçar o carregamento sem verificar o contorno, marque essa caixa.

Saídas

Saída Tipo de saída
Arquivo de erro de carregamento de metadados Arquivo

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Consulta MDX

Para executar uma consulta de expressões multidimensionais (MDX), adicione um comando MDX query.

Propriedades

Propriedade Detalhes
Texto da consulta

Digite o texto da consulta MDX. Nenhum ponto e vírgula (;) é necessário no final.

Observação: Isso é opcional se O arquivo de consulta for fornecido.
Arquivo de consulta

Faça o upload do script MDX como um arquivo.

Observação: Isso é opcional se você tiver fornecido Texto da consulta.
Aplicação Digite o nome do aplicativo Essbase.
Banco de dados Digite o nome do banco de dados do Essbase.
Identificador de membro Selecione se você deseja identificar membros nos resultados da consulta por nome, alias ou nome exclusivo.
Preservar tuplas Para manter quaisquer tuplas - ou agrupamentos de dados - da consulta em sua saída CSV, marque essa caixa. 
Delimitador de tuplas Se a opção Preserve tuples estiver marcada, digite o delimitador usado para separar as tuplas.
Remover cabeçalho Para que e não inclua um cabeçalho no CSV da consulta MDX, marque essa caixa.

Saídas

Saída Tipo de saída
Consulta MDX CSV Arquivo
Contagem de registros da consulta MDX Inteiro

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Gerenciar aplicativo

Para iniciar, parar ou gerenciar conexões com um determinado aplicativo, adicione um comando Manage application.

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.
Ação Selecione a ação a ser tomada.

Saídas

Nenhum

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Gerenciar banco de dados

Para iniciar ou parar um determinado banco de dados, adicione um comando Manage database.

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.
Banco de dados Digite o nome do banco de dados do Essbase.
Ação Selecione a ação a ser tomada.

Saídas

Nenhum

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Gerenciar variável

Para criar, atualizar ou excluir uma variável, adicione um comando Manage variable.

Propriedades

Propriedade Detalhes
Localização da variável Selecione se a variável está definida no nível do aplicativo, do banco de dados ou global.
Ação Selecione a ação a ser executada.
Nome da variável Digite o nome da variável a ser modificada.
Valor da variável Digite o nome da variável a ser definida. Para excluir a variável, deixe em branco.
Aplicação Se a entrada Variable location for Application (Aplicativo) ou Database (Banco de dados), digite o nome do aplicativo Essbase.
Banco de dados Se a entrada Variable location for Database, digite o nome do banco de dados do Essbase.

Saídas

Nenhum

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Definir cálculo padrão

Para definir um script de cálculo como o cálculo padrão, adicione um comando Set default calculation.

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.
Banco de dados Digite o nome do banco de dados do Essbase.
Arquivo de script Digite o nome do script de cálculo a ser definido como padrão.

Saídas

Nenhum

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral

Carregar arquivo

Para fazer upload de um arquivo para o servidor, adicione um comando Upload file.

Propriedades

Propriedade Detalhes
Aplicação Digite o nome do aplicativo Essbase.
Banco de dados Digite o nome do banco de dados do Essbase.
Arquivo Digite o arquivo de origem a ser carregado.
Nome do upload Para renomear o arquivo carregado, digite o novo nome.
Sobrescrever Para substituir um arquivo já existente no servidor, marque essa caixa.

Saídas

Nenhum

Códigos de saída

Código Tipo Detalhes
0 Sucesso Sucesso
1 Erro Argumentos inválidos
3 Erro Falha geral
Para gerenciar cubos do Oracle Essbase® no local como parte de uma cadeia, adicione uma etapa que inclua um comando d...