若要將雲端或內部部署版本的 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 中執行流程,請使用執行流程 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 流程名稱 |
輸入要執行的流程名稱。 |
| 進程參數 |
輸入要執行程序的參數。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效參數 |
| 2 |
錯誤 |
與 TM1 通訊失敗 |
| 3 |
錯誤 |
指令執行失敗 |
| 10 |
錯誤 |
無效參數 |
| 53 |
錯誤 |
程序運行失敗 |
| 55 |
錯誤 |
程序運行失敗 |
執行 MDX
若要執行多維表達式 (MDX) 函式並將其匯出為 CSV,請使用Execute MDX 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| MDX 函式 |
輸入要執行的 MDX 函式。 |
| 輸出類型 |
選擇產生的 CSV 檔案格式。 |
| 啟用價值報價 |
若為空白(預設),則資料流中的逗號將被視為元素分隔符號。 範例: March 30, 2026 將被視為兩個元素:「3 月 30 日」和「2026」。
如果已標示,則包含逗號的元素將被視為單一資料元素。(逗號會被視為標點符號,而非資料元素分隔符號。) 範例: March 30, 2026 將被視為一個元素:「2026 年 3 月 30 日」。
|
| skipEmpty |
若為空白 (預設值),則結果中會包含空白 (NULL) 儲存格。
如果已標記,則空 (NULL) 儲存格不會包含在結果中。
|
輸出
| 輸出 |
輸出類型 |
| 儲存格資料 |
檔案 |
| 細胞集 ID |
字串 |
| 已處理的單元總數 |
整數 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效參數 |
| 2 |
錯誤 |
與 TM1 通訊失敗 |
| 3 |
錯誤 |
指令執行失敗 |
篩選訊息日誌
若要列出伺服器的訊息記錄,請使用Filter message logs 指令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 開始日期 |
輸入記錄的開始日期篩選條件。 |
| 結束日期 |
輸入記錄的結束日期篩選條件。 |
| 最大結果 |
輸入要擷取的最大記錄項目數量。 |
输出
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效參數 |
| 2 |
錯誤 |
與 TM1 通訊失敗 |
| 3 |
錯誤 |
指令執行失敗 |
篩選交易記錄
若要列出伺服器的事務記錄,請使用Filter 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 |
錯誤 |
指令執行失敗 |
讀取檢視儲存格
使用Read view cells 命令,可以生成以分层作为视图中所有单元格值的标题的 CSV。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 立方體名稱 |
輸入立方體的名稱。 |
| 檢視名稱 |
輸入檢視名稱 |
| 輸出類型 |
選擇產生的 CSV 檔案格式。 |
输出
| 輸出 |
輸出類型 |
| 檢視資料 |
檔案 |
| 呼叫組 ID |
字串 |
| 已處理的單元總數 |
整數 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效參數 |
| 2 |
錯誤 |
與 TM1 通訊失敗 |
| 3 |
錯誤 |
指令執行失敗 |
更新工作參數
要更改给定杂务任务的参数设置,请使用更新杂务任务参数 命令。
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 工作表名稱 |
輸入雜務的名稱。 |
| 任務編號 |
輸入要更新參數的任務編號。 |
| 參數 |
輸入該任務的新參數值。 |
输出
無
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效參數 |
| 2 |
錯誤 |
與 TM1 通訊失敗 |
| 3 |
錯誤 |
指令執行失敗 |
| 10 |
錯誤 |
無效的工作參數 |
| 13 |
錯誤 |
指定的工作任務沒有參數 |
| 17 |
錯誤 |
工作有活動排程 |
寫入立方體單元
要寫入數值到一個立方體,使用Write cube cells 指令。此指令需要一個以逗號分隔的值 (CSV) 檔案,其中包含:
- 層級唯一的名稱作為標頭
- 列標頭 Value,包含要寫入立方體的值
摘要資訊
| 摘要資訊 |
詳細資訊 |
| 立方體名稱 |
輸入立方體的名稱。 |
| 檔案格式 |
選擇 CSV 檔案的格式。 |
| CSV檔案 |
輸入 CSV 原始檔案。 |
输出
| 輸出 |
輸出類型 |
| 儲存格更新次數 |
整數 |
| 失敗的儲存格寫入 |
整數 |
退出代碼
| 代碼 |
類型 |
詳細資訊 |
| 0 |
成功 |
成功 |
| 1 |
錯誤 |
無效參數 |
| 2 |
錯誤 |
與 TM1 通訊失敗 |
| 3 |
錯誤 |
命令執行失敗 |
| 16 |
錯誤 |
某些儲存格無法寫入立方體 |