|
自 2021 年 1 月起，经典文件类型不再可用。您可以转换经典文件或下载 PDF 文件。了解更多

Workiva支持中心

IBM Planning Analytics TM1 命令

IBM Planning Analytics TM1 命令

  • 上次更新时间

要将云端或本地版本的 IBM TM1® 作为链的一部分进行自动化，请添加一个包含 IBM® Planning Analytics 连接命令的步骤。例如：

  • 自动化 TM1 任务和流程
  • 查询TM1日志文件
  • 与包括关系数据库、Workday®、NetSuite®、Namely® 和 Salesforce® 在内的多种应用程序进行双向数据交换。

要启用这些命令，IT 管理员 首先需要创建一个 IBM Planning AnalyticsTM1连接器。

启动一项家务

要激活一项家务，请使用 激活一项家务 命令。

属性

摘要信息 细节
家务名称 请输入要激活的家务名称。

输出

没有任何

退出代码

代码 类型 细节
0 成功 成功
1 错误 无效参数
2 错误 与 TM1 通信失败
3 错误 命令运行失败

取消一项任务

要停用一项任务，请使用 停用一项任务 命令。

属性

摘要信息 细节
家务名称 请输入要停用的家务名称。

输出

没有任何

退出代码

代码 类型 细节
0 成功 成功
1 错误 无效参数
2 错误 与 TM1 通信失败
3 错误 命令运行失败

删除一项家务

要删除一项家务，请使用 删除一项家务 命令。

属性

摘要信息 细节
家务名称 请输入要删除的家务名称。

输出

没有任何

退出代码

代码 类型 细节
0 成功 成功
1 错误 无效参数
2 错误 与 TM1 通信失败
3 错误 命令运行失败

删除一个立方体

要删除一个立方体，请使用 删除立方体 命令。

属性

摘要信息 细节
立方体名称 请输入要删除的立方体的名称。

输出

没有任何

退出代码

代码 类型 细节
0 成功 成功
1 错误 无效参数
2 错误 与 TM1 通信失败
3 错误 命令运行失败

删除多维数据集视图

要删除多维数据集视图，请使用 删除多维数据集视图 命令。

属性

摘要信息 细节
立方体名称 请输入要从中删除内容的立方体的名称。
视图名称 请输入要删除的视图名称。

输出

没有任何

退出代码

代码 类型 细节
0 成功 成功
1 错误 无效参数
2 错误 与 TM1 通信失败
3 错误 命令运行失败

删除进程

要在 TM1 中删除进程，请使用 删除进程 命令。

属性

摘要信息 细节
进程名称 请输入进程名称。

输出

没有任何

退出代码

代码 类型 细节
0 成功 成功
1 错误 无效参数
2 错误 与 TM1 通信失败
3 错误 命令运行失败

完成一项家务

要在 TM1 中执行家务，请使用 执行家务 命令。

属性

摘要信息 细节
家务名称 请输入要运行的任务名称。

输出

没有任何

退出代码

代码 类型 细节
0 成功 成功
1 错误 无效参数
2 错误 与 TM1 通信失败
3 错误 命令运行失败

执行流程

要在 TM1 中运行进程，请使用 执行进程 命令。

属性

摘要信息 细节
进程名称 请输入要运行的进程名称。
进程参数 请输入运行该进程所需的参数。

输出

没有任何

退出代码

代码 类型 细节
0 成功 成功
1 错误 无效参数
2 错误 与 TM1 通信失败
3 错误 命令运行失败
10 错误 无效参数
53 错误 该进程运行失败
55 错误 该进程运行失败

执行 MDX

要运行多维表达式 (MDX) 函数并将其导出到 CSV，请使用 Execute MDX 命令。

属性

摘要信息 细节
MDX 函数 输入要执行的MDX函数。
输出类型 选择生成的 CSV 文件的格式。
启用价值报价

如果为空（默认值），则数据流中的逗号将被视为元素分隔符。
例如：2026 年 3 月 30 日 将被视为两个元素：“3 月 30 日”和“2026 年”。

如果标记，则含有逗号的元素将被视为单个数据元素。（逗号被视为标点符号，而不是数据元素分隔符。
）例如： 2026 年 3 月 30 日 将被视为一个元素：“2026 年 3 月 30 日”。
跳过空

如果为空白（默认值），则结果中包含空（null）单元格。

如果已标记，则空（null）单元格不包含在结果中。

输出

输出 输出类型
细胞数据 文件
单元集 ID 字串
处理的总细胞数 整数

退出代码

代码 类型 细节
0 成功 成功
1 错误 无效参数
2 错误 与 TM1 通信失败
3 错误 命令运行失败

筛选消息日志

要列出服务器的消息日志，请使用筛选 message logs 命令。

属性

摘要信息 细节
开始日期 输入日志的起始日期筛选条件。
结束日期 输入日志的结束日期筛选条件。
最大结果 请输入要检索的最大日志条目数。

输出

输出 输出类型
日志档案 文件
日志条目计数 整数

退出代码

代码 类型 细节
0 成功 成功
1 错误 无效参数
2 错误 与 TM1 通信失败
3 错误 命令运行失败

筛选交易日志

要列出服务器的事务日志，请使用筛选 transaction logs 命令。

属性

摘要信息 细节
开始日期 输入日志的起始日期筛选条件。
结束日期 输入日志的结束日期筛选条件。
最大结果 请输入要检索的最大日志条目数。
立方体过滤器 输入要检索事务日志的多维数据集的筛选条件。
用户筛选器 输入要检索其交易日志的用户筛选条件。

输出

输出 输出类型
日志档案 文件
日志条目计数 整数

退出代码

代码 类型 细节
0 成功 成功
1 错误 无效参数
2 错误 与 TM1 通信失败
3 错误 命令运行失败

获取进程错误日志

要检索进程错误日志的 ZIP 文件，请使用 获取进程错误日志 命令。

属性

摘要信息 细节
开始日期 输入日志的起始日期筛选条件。
结束日期 输入日志的结束日期筛选条件。
进程名称 请输入进程名称。

输出

输出 输出类型
压缩日志 文件
日志文件计数 整数

退出代码

代码 类型 细节
0 成功 成功
1 错误 无效参数
2 错误 与 TM1 通信失败
3 错误 命令运行失败

列出家务任务

要列出家务中的可用任务，请使用 List chore tasks 命令。

属性

摘要信息 细节
家务名称 输入家务名称，列出其任务。

输出

输出 输出类型
家务任务步骤 大批
家务任务数量 整数

退出代码

代码 类型 细节
0 成功 成功
1 错误 无效参数
2 错误 与 TM1 通信失败
3 错误 命令运行失败

列出家务活

要列出可用的家务，请使用 List chores 命令。

属性

没有任何

输出

输出 输出类型
家务名称 大批
家务活动设置 大批
家务活数量 整数

退出代码

代码 类型 细节
0 成功 成功
1 错误 无效参数
2 错误 与 TM1 通信失败
3 错误 命令运行失败

列出立方体维度

要列出立方体的维度，请使用 列出立方体维度 命令。

属性

摘要信息 细节
立方体名称 输入立方体的名称，即可列出其尺寸。

输出

输出 输出类型
维度名称 大批
维度唯一名称 大批
维度计数 整数

退出代码

代码 类型 细节
0 成功 成功
1 错误 无效参数
2 错误 与 TM1 通信失败
3 错误 命令运行失败

列表立方体视图

要列出多维数据集中的视图，请使用 列出多维数据集视图 命令。

属性

摘要信息 细节
立方体名称 输入要列出视图的立方体的名称。

输出

输出 输出类型
视图名称 大批
浏览量 整数

退出代码

代码 类型 细节
0 成功 成功
1 错误 无效参数
2 错误 与 TM1 通信失败
3 错误 命令运行失败

列出立方体

要列出立方体，请使用 List cubes 命令。

属性

没有任何

输出

输出 输出类型
立方体名称 大批
立方体计数 整数

退出代码

代码 类型 细节
0 成功 成功
1 错误 无效参数
2 错误 与 TM1 通信失败
3 错误 命令运行失败

列出进程

要列出可用进程，请使用 List processes 命令。

属性

没有任何

输出

输出 输出类型
进程名称 大批
流程计数 整数

退出代码

代码 类型 细节
0 成功 成功
1 错误 无效参数
2 错误 与 TM1 通信失败
3 错误 命令运行失败

列出用户

要列出 TM1 服务器上的用户，请使用 List users 命令。

属性

没有任何

输出

输出 输出类型
用户唯一名称 大批
用户名 大批
用户类型 大批
用户已启用 大批
用户活跃度 大批
用户数量 整数

退出代码

代码 类型 细节
0 成功 成功
1 错误 无效参数
2 错误 与 TM1 通信失败
3 错误 命令运行失败

读取视图单元格

要生成以视图中所有单元格值的层次结构作为标题的 CSV，请使用 读取视图单元格 命令。

属性

摘要信息 细节
立方体名称 请输入立方体的名称。
视图名称 请输入视图名称。
输出类型 选择生成的 CSV 文件的格式。

输出

输出 输出类型
查看数据 文件
呼叫集 ID 字串
处理的总细胞数 整数

退出代码

代码 类型 细节
0 成功 成功
1 错误 无效参数
2 错误 与 TM1 通信失败
3 错误 命令运行失败

更新家务任务参数

要更改给定家务任务的参数设置，请使用 更新家务任务参数 命令。

属性

摘要信息 细节
家务名称 请输入家务名称。
任务编号 请输入要更新参数的任务编号。
参数 输入任务的新参数值。

输出

没有任何

退出代码

代码 类型 细节
0 成功 成功
1 错误 无效参数
2 错误 与 TM1 通信失败
3 错误 命令运行失败
10 错误 无效的家务任务参数
13 错误 指定的家务任务没有参数
17 错误 这项家务活有固定的日程安排。

写入立方体单元格

要向立方体写入值，请使用 Write cube cells 命令。此命令需要一个以逗号分隔值 (CSV) 开头的文件，其中包含：

  • 层级唯一名称作为标题
  • 列标题“值”，其中包含要写入多维数据集的值。

属性

摘要信息 细节
立方体名称 请输入立方体的名称。
文件格式 选择CSV文件的格式。
CSV 文件 请输入CSV源文件。

输出

输出 输出类型
细胞计数已更新 整数
单元格写入失败 整数

退出代码

代码 类型 细节
0 成功 成功
1 错误 无效参数
2 错误 与 TM1 通信失败
3 错误 命令运行失败
16 错误 部分单元格无法写入立方体
这篇文章有帮助吗？
0 人中有 0 人觉得有帮助
要将云端或本地版本的 IBM TM1® 作为链的一部分进行自动化，请添加一个包含 IBM® Planning Analytics 连接命令的步骤。例如： 自动化 TM1 任务和流程 查询TM1日志文件 与包括关系数据库、Workday...