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 IBM Planning Analytics TM1
Comandos do IBM Planning Analytics TM1
Última atualização em
Para automatizar a versão em nuvem ou local do IBM TM1® como parte de uma cadeia, adicione uma etapa que inclua um comando de conexão do IBM® Planning Analytics. Por exemplo:
Automatizar tarefas e processos do TM1
Consultar arquivos de registro do TM1
Troque dados bidirecionalmente com uma variedade de aplicativos, incluindo bancos de dados relacionais, Workday®, NetSuite®, Namely® e Salesforce®.
Para ativar uma tarefa, use o comando Activate a chore.
Propriedades
Propriedade
Detalhes
Nome da tarefa
Digite o nome da tarefa a ser ativada.
Saídas
Nenhum
Códigos de saída
Código
Tipo
Detalhes
0
Sucesso
Sucesso
1
Erro
Argumentos inválidos
2
Erro
Falha na comunicação com o TM1
3
Erro
Falha na execução do comando
Desativar uma tarefa
Para desativar uma tarefa, use o comando Deactivate a chore.
Propriedades
Propriedade
Detalhes
Nome da tarefa
Digite o nome da tarefa a ser desativada.
Saídas
Nenhum
Códigos de saída
Código
Tipo
Detalhes
0
Sucesso
Sucesso
1
Erro
Argumentos inválidos
2
Erro
Falha na comunicação com o TM1
3
Erro
Falha na execução do comando
Excluir uma tarefa
Para excluir uma tarefa, use o comando Delete a chore (Excluir uma tarefa).
Propriedades
Propriedade
Detalhes
Nome da tarefa
Digite o nome da tarefa a ser excluída.
Saídas
Nenhum
Códigos de saída
Código
Tipo
Detalhes
0
Sucesso
Sucesso
1
Erro
Argumentos inválidos
2
Erro
Falha na comunicação com o TM1
3
Erro
Falha na execução do comando
Excluir um cubo
Para excluir um cubo, use o comando Excluir um cubo.
Propriedades
Propriedade
Detalhes
Nome do cubo
Digite o nome do cubo a ser excluído.
Saídas
Nenhum
Códigos de saída
Código
Tipo
Detalhes
0
Sucesso
Sucesso
1
Erro
Argumentos inválidos
2
Erro
Falha na comunicação com o TM1
3
Erro
Falha na execução do comando
Excluir uma visualização de cubo
Para excluir uma visualização de cubo, use o comando Excluir uma visualização de cubo.
Propriedades
Propriedade
Detalhes
Nome do cubo
Digite o nome do cubo do qual você deseja excluir.
Exibir nome
Digite o nome da visualização a ser excluída.
Saídas
Nenhum
Códigos de saída
Código
Tipo
Detalhes
0
Sucesso
Sucesso
1
Erro
Argumentos inválidos
2
Erro
Falha na comunicação com o TM1
3
Erro
Falha na execução do comando
Excluir um processo
Para excluir um processo no TM1, use o comando Excluir um processo.
Propriedades
Propriedade
Detalhes
Nome do processo
Digite o nome do processo.
Saídas
Nenhum
Códigos de saída
Código
Tipo
Detalhes
0
Sucesso
Sucesso
1
Erro
Argumentos inválidos
2
Erro
Falha na comunicação com o TM1
3
Erro
Falha na execução do comando
Executar uma tarefa
Para executar uma tarefa no TM1, use o comando Execute a chore.
Observação: Para executar uma tarefa manualmente, não a ative.
Propriedades
Propriedade
Detalhes
Nome da tarefa
Digite o nome da tarefa a ser executada.
Saídas
Nenhum
Códigos de saída
Código
Tipo
Detalhes
0
Sucesso
Sucesso
1
Erro
Argumentos inválidos
2
Erro
Falha na comunicação com o TM1
3
Erro
Falha na execução do comando
Executar um processo
Para executar um processo no TM1, use o comando Executar um processo.
Propriedades
Propriedade
Detalhes
Nome do processo
Digite o nome do processo a ser executado.
Parâmetros do processo
Digite os parâmetros com os quais você deseja executar o processo.
Saídas
Nenhum
Códigos de saída
Código
Tipo
Detalhes
0
Sucesso
Sucesso
1
Erro
Argumentos inválidos
2
Erro
Falha na comunicação com o TM1
3
Erro
Falha na execução do comando
10
Erro
Parâmetro inválido
53
Erro
O processo falhou ao ser executado
55
Erro
O processo falhou ao ser executado
Executar MDX
Para executar uma função de expressão multidimensional (MDX) e exportá-la para um arquivo CSV, use o comando Execute MDX.
Propriedades
Propriedade
Detalhes
Função MDX
Digite a função MDX a ser executada.
Tipo de saída
Selecione o formato do arquivo CSV gerado.
Ativar cotação de valores
Se estiver em branco (padrão), as vírgulas no fluxo de dados serão tratadas como separadores de elementos. Exemplo: 30 de março de 2026 seria tratado como dois elementos: "March 30" e "2026".
Se marcados, os elementos que contêm vírgulas são tratados como um único elemento de dados. (As vírgulas são tratadas como pontuação e não como separadores de elementos de dados.) Exemplo: 30 de março de 2026 seria tratado como um único elemento: "March 30, 2026".
skipEmpty
Se estiver em branco (padrão), as células vazias (nulas) serão incluídas nos resultados.
Se marcada, as células vazias (nulas) não serão incluídas nos resultados.
Saídas
Saída
Tipo de saída
Dados da célula
Arquivo
ID do cellset
String
Total de células processadas
Inteiro
Códigos de saída
Código
Tipo
Detalhes
0
Sucesso
Sucesso
1
Erro
Argumentos inválidos
2
Erro
Falha na comunicação com o TM1
3
Erro
Falha na execução do comando
Filtrar logs de mensagens
Para listar os logs de mensagens do servidor, use o comando Filter message logs.
Propriedades
Propriedade
Detalhes
Data de início
Insira o filtro de data de início para os registros.
Data de encerramento
Insira o filtro de data final para os registros.
Resultados máximos
Digite o número máximo de entradas de registro a serem recuperadas.
Saídas
Saída
Tipo de saída
Arquivo de registro
Arquivo
Contagem de entradas de registro
Inteiro
Códigos de saída
Código
Tipo
Detalhes
0
Sucesso
Sucesso
1
Erro
Argumentos inválidos
2
Erro
Falha na comunicação com o TM1
3
Erro
Falha na execução do comando
Filtrar logs de transação
Para listar os logs de transação do servidor, use o comando Filter transaction logs.
Propriedades
Propriedade
Detalhes
Data de início
Insira o filtro de data de início para os registros.
Data de encerramento
Insira o filtro de data final para os registros.
Resultados máximos
Digite o número máximo de entradas de registro a serem recuperadas.
Filtro de cubo
Insira os critérios de filtro do cubo para o qual você deseja recuperar os logs de transação.
Filtro de usuário
Insira os critérios de filtro para os quais o usuário deve recuperar os logs de transação.
Saídas
Saída
Tipo de saída
Arquivo de registro
Arquivo
Contagem de entradas de registro
Inteiro
Códigos de saída
Código
Tipo
Detalhes
0
Sucesso
Sucesso
1
Erro
Argumentos inválidos
2
Erro
Falha na comunicação com o TM1
3
Erro
Falha na execução do comando
Obter registros de erros do processo
Para recuperar um arquivo ZIP dos registros de erros do processo, use o comando Get process error logs.
Propriedades
Propriedade
Detalhes
Data de início
Insira o filtro de data de início para os registros.
Data de encerramento
Insira o filtro de data final para os registros.
Nome do processo
Digite o nome do processo.
Saídas
Saída
Tipo de saída
Registros compactados
Arquivo
Contagem de arquivos de registro
Inteiro
Códigos de saída
Código
Tipo
Detalhes
0
Sucesso
Sucesso
1
Erro
Argumentos inválidos
2
Erro
Falha na comunicação com o TM1
3
Erro
Falha na execução do comando
Listar tarefas da tarefa
Para listar as tarefas disponíveis em uma tarefa, use o comando List chore tasks.
Propriedades
Propriedade
Detalhes
Nome da tarefa
Digite o nome da tarefa para listar as tarefas.
Saídas
Saída
Tipo de saída
Etapas da tarefa da tarefa
Matriz
Contagem de tarefas de tarefas
Inteiro
Códigos de saída
Código
Tipo
Detalhes
0
Sucesso
Sucesso
1
Erro
Argumentos inválidos
2
Erro
Falha na comunicação com o TM1
3
Erro
Falha na execução do comando
Listar tarefas
Para listar as tarefas disponíveis, use o comando List chores.
Propriedades
Nenhum
Saídas
Saída
Tipo de saída
Nomes de tarefas
Matriz
Configurações de tarefas ativas
Matriz
Contagem de tarefas
Inteiro
Códigos de saída
Código
Tipo
Detalhes
0
Sucesso
Sucesso
1
Erro
Argumentos inválidos
2
Erro
Falha na comunicação com o TM1
3
Erro
Falha na execução do comando
Listar dimensões do cubo
Para listar as dimensões em um cubo, use o comando Listar dimensões do cubo.
Propriedades
Propriedade
Detalhes
Nome do cubo
Digite o nome do cubo para listar as dimensões.
Saídas
Saída
Tipo de saída
Nomes de dimensões
Matriz
Nomes exclusivos da dimensão
Matriz
Contagem de dimensões
Inteiro
Códigos de saída
Código
Tipo
Detalhes
0
Sucesso
Sucesso
1
Erro
Argumentos inválidos
2
Erro
Falha na comunicação com o TM1
3
Erro
Falha na execução do comando
Listar visualizações de cubo
Para listar as visualizações em um cubo, use o comando Listar visualizações de cubo.
Propriedades
Propriedade
Detalhes
Nome do cubo
Digite o nome do cubo para listar as visualizações.
Saídas
Saída
Tipo de saída
Ver nomes
Matriz
Contagem de visualizações
Inteiro
Códigos de saída
Código
Tipo
Detalhes
0
Sucesso
Sucesso
1
Erro
Argumentos inválidos
2
Erro
Falha na comunicação com o TM1
3
Erro
Falha na execução do comando
Listar cubos
Para listar os cubos, use o comando List cubes.
Propriedades
Nenhum
Saídas
Saída
Tipo de saída
Nomes de cubos
Matriz
Contagem de cubos
Inteiro
Códigos de saída
Código
Tipo
Detalhes
0
Sucesso
Sucesso
1
Erro
Argumentos inválidos
2
Erro
Falha na comunicação com o TM1
3
Erro
Falha na execução do comando
Listar processos
Para listar os processos disponíveis, use o comando List processes.
Propriedades
Nenhum
Saídas
Saída
Tipo de saída
Nomes de processos
Matriz
Contagem de processos
Inteiro
Códigos de saída
Código
Tipo
Detalhes
0
Sucesso
Sucesso
1
Erro
Argumentos inválidos
2
Erro
Falha na comunicação com o TM1
3
Erro
Falha na execução do comando
Listar usuários
Para listar os usuários no servidor TM1, use o comando List users.
Propriedades
Nenhum
Saídas
Saída
Tipo de saída
Nomes exclusivos de usuários
Matriz
Nomes de usuários
Matriz
Tipos de usuários
Matriz
Usuário habilitado
Matriz
Ativos do usuário
Matriz
Contagem de usuários
Inteiro
Códigos de saída
Código
Tipo
Detalhes
0
Sucesso
Sucesso
1
Erro
Argumentos inválidos
2
Erro
Falha na comunicação com o TM1
3
Erro
Falha na execução do comando
Ler células de exibição
Para gerar um CSV com hierarquias como cabeçalhos de todos os valores de célula em uma exibição, use o comando Read view cells.
Propriedades
Propriedade
Detalhes
Nome do cubo
Digite o nome do cubo.
Exibir nome
Inserir nome da exibição
Tipo de saída
Selecione o formato do arquivo CSV gerado.
Saídas
Saída
Tipo de saída
Exibir dados
Arquivo
ID do conjunto de chamadas
String
Total de células processadas
Inteiro
Códigos de saída
Código
Tipo
Detalhes
0
Sucesso
Sucesso
1
Erro
Argumentos inválidos
2
Erro
Falha na comunicação com o TM1
3
Erro
Falha na execução do comando
Atualizar parâmetros da tarefa de core
Para alterar os parâmetros definidos para uma determinada tarefa de tarefa, use o comando Update chore task parameters (Atualizar parâmetros da tarefa de tarefa).
Propriedades
Propriedade
Detalhes
Nome da tarefa
Digite o nome da tarefa.
Número da tarefa
Digite o número da tarefa para a qual você deseja atualizar os parâmetros.
Parâmetros
Digite os novos valores de parâmetro para a tarefa.
Saídas
Nenhum
Códigos de saída
Código
Tipo
Detalhes
0
Sucesso
Sucesso
1
Erro
Argumentos inválidos
2
Erro
Falha na comunicação com o TM1
3
Erro
Falha na execução do comando
10
Erro
Parâmetro de tarefa de tarefa inválido
13
Erro
As tarefas de tarefas especificadas não têm parâmetros
17
Erro
A tarefa tem uma programação ativa
Gravar células de cubo
Para gravar valores em um cubo, use o comando Write cube cells. Esse comando requer um arquivo de valores separados por vírgula (CSV) com:
Nomes exclusivos da hierarquia como cabeçalhos
Um cabeçalho de coluna Value, com os valores a serem gravados no cubo
Propriedades
Propriedade
Detalhes
Nome do cubo
Digite o nome do cubo.
Formato do arquivo
Selecione o formato do arquivo CSV.
Arquivo CSV
Insira o arquivo de origem CSV.
Saídas
Saída
Tipo de saída
Contagem atualizada de células
Inteiro
Falha na gravação de células
Inteiro
Códigos de saída
Código
Tipo
Detalhes
0
Sucesso
Sucesso
1
Erro
Argumentos inválidos
2
Erro
Falha na comunicação com o TM1
3
Erro
Falha na execução do comando
16
Erro
Algumas células não conseguiram gravar no cubo
Para automatizar a versão em nuvem ou local do IBM TM1® como parte de uma cadeia, adicione uma etapa que inclua um co...