Para automatizar sua versão na 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 habilitar esses comandos, um administrador de TI primeiro cria um conector IBM Planning Analytics TM1.
Ativar uma tarefa
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 a 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 a TM1 |
| 3 | Erro | Falha na execução do comando |
Excluir uma tarefa
Para excluir uma tarefa, use o comando Delete a chore .
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 a TM1 |
| 3 | Erro | Falha na execução do comando |
Excluir um cubo
Para excluir um cubo, use o comando Delete a cube .
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 a 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 Delete a cube view .
Propriedades
| Propriedade | Detalhes |
|---|---|
| Nome do cubo | Digite o nome do cubo do qual deseja excluir. |
| Ver 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 a TM1 |
| 3 | Erro | Falha na execução do comando |
Excluir um processo
Para excluir um processo no TM1, use o comando Delete a process .
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 a 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 a TM1 |
| 3 | Erro | Falha na execução do comando |
Executar um processo
Para executar um processo no TM1, use o comando Execute a process .
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 o processo será executado. |
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 a TM1 |
| 3 | Erro | Falha na execução do comando |
| 10 | Erro | Parâmetro inválido |
| 53 | Erro | O processo não foi executado |
| 55 | Erro | O processo não foi 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. |
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 a TM1 |
| 3 | Erro | Falha na execução do comando |
Filtrar registros de mensagens
Para listar os registros 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 final | 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 a TM1 |
| 3 | Erro | Falha na execução do comando |
Filtrar registros de transações
Para listar os registros de transações 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 final | 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 deseja recuperar os registros de transação. |
| Filtro de usuário | Insira os critérios de filtro para os quais o usuário deve recuperar os registros 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 a 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 final | 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 com zíper | 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 a TM1 |
| 3 | Erro | Falha na execução do comando |
Listar tarefas de tarefas
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 a TM1 |
| 3 | Erro | Falha na execução do comando |
Lista de 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 a TM1 |
| 3 | Erro | Falha na execução do comando |
Listar as dimensões do cubo
Para listar as dimensões em um cubo, use o comando List cube dimensions .
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 de 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 a TM1 |
| 3 | Erro | Falha na execução do comando |
Lista de visualizações de cubo
Para listar as visualizações em um cubo, use o comando List cube views .
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 |
| Ver contagem | 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 a 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 a 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 a 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 a TM1 |
| 3 | Erro | Falha na execução do comando |
Ler células de visualização
Para gerar um CSV com hierarquias como cabeçalhos de todos os valores de células em uma visualização, use o comando Read view cells .
Propriedades
| Propriedade | Detalhes |
|---|---|
| Nome do cubo | Digite o nome do cubo. |
| Ver nome | Digite o nome da visualizaçã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 a TM1 |
| 3 | Erro | Falha na execução do comando |
Atualizar os parâmetros da tarefa da tarefa
Para alterar os parâmetros definidos para uma determinada tarefa de tarefa, use o comando Update chore task parameters .
Propriedades
| Propriedade | Detalhes |
|---|---|
| Nome da tarefa | Digite o nome da tarefa. |
| Número da tarefa | Digite o número da tarefa para a qual deseja atualizar os parâmetros. |
| Parâmetros | Digite os novos valores de parâmetros 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 a 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 |
Escrever 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 | Digite 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 a TM1 |
| 3 | Erro | Falha na execução do comando |
| 16 | Erro | Algumas células não conseguiram gravar no cubo |