Workiva 支持中心

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

• 自动执行 TM1 任务和流程
• 查询 TM1 日志文件
• 与关系数据库、Workday®、NetSuite®、Namely® 和 Salesforce® 等一系列应用程序进行双向数据交换

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

启动杂务

要激活杂务，请使用 激活杂务 命令。

属性

摘要信息	详细信息
工作名称	输入要激活的杂务名称。

输出

没有任何

退出代码

代码	类型	详细信息
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 中的进程，请使用 Delete a process 命令。

属性

摘要信息	详细信息
过程名称	输入流程名称。

输出

没有任何

退出代码

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

执行杂务

要在 TM1 中运行杂务，请使用 Execute a chore 命令。

注意： 要手动运行某项家务劳动，请不要激活它。

属性

摘要信息	详细信息
工作名称	输入要运行的杂事名称。

输出

没有任何

退出代码

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

执行进程

要在 TM1 中运行进程，请使用 Execute a process 命令。

属性

摘要信息	详细信息
过程名称	输入要运行的进程名称。
处理参数	输入要运行进程的参数。

输出

没有任何

退出代码

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

执行 MDX

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

属性

摘要信息	详细信息
MDX 功能	输入要执行的 MDX 函数。
输出类型	选择生成 CSV 文件的格式。

输出

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

退出代码

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

过滤信息日志

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

属性

摘要信息	详细信息
开始日期	输入日志的开始日期筛选器。
结束日期	输入日志的结束日期筛选器。
最大结果	输入要检索的日志条目的最大数量。

输出

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

退出代码

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

过滤事务日志

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

属性

摘要信息	详细信息
开始日期	输入日志的开始日期筛选器。
结束日期	输入日志的结束日期筛选器。
最大结果	输入要检索的日志条目的最大数量。
立方体过滤器	输入要检索事务日志的立方体的筛选条件。
用户过滤器	输入要检索交易日志的用户的筛选条件。

输出

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

退出代码

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

获取进程错误日志

要检索进程错误日志的 ZIP 文件，请使用 Get process error logs 命令。

属性

摘要信息	详细信息
开始日期	输入日志的开始日期筛选器。
结束日期	输入日志的结束日期筛选器。
过程名称	输入流程名称。

输出

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

退出代码

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

列出家务劳动任务

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

属性

摘要信息	详细信息
工作名称	输入要列出任务的家务名称。

输出

输出	输出类型
杂务任务步骤	阵列
家务任务计数	整数

退出代码

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

列出家务

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

属性

没有任何

输出

输出	输出类型
家务劳动名称	阵列
家务活动设置	阵列
家务计数	整数

退出代码

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

列出立方体尺寸

要列出立方体中的尺寸，请使用 List cube dimensions 命令。

属性

摘要信息	详细信息
立方体名称	输入要列出尺寸的立方体名称。

输出

输出	输出类型
尺寸名称	阵列
尺寸唯一名称	阵列
尺寸数	整数

退出代码

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

列表立方体视图

要列出立方体中的视图，请使用 List cube views 命令。

属性

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

输出

输出	输出类型
查看名称	阵列
查看次数	整数

退出代码

代码	类型	详细信息
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，请使用 Read view cells 命令。

属性

摘要信息	详细信息
立方体名称	输入立方体的名称。
查看名称	输入视图的名称。
输出类型	选择生成 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	错误	某些单元格无法写入立方体