To automate your cloud or on-premise version of IBM TM1® as part of a chain, add a step that includes an IBM® Planning Analytics connection command. For example:
- Automate TM1 Chores & Processes
- Query TM1 log files
- Bi-directionally exchange data with a range of applications, including relational databases, Workday®, NetSuite®, Namely®, and Salesforce®
To enable these commands, an IT admin first creates an IBM Planning Analytics TM1 connector.
Activate a chore
To activate a chore, use an Activate a chore command.
Properties
| Property | Detail |
|---|---|
| Chore name | Enter the name of the chore to activate. |
Outputs
None
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Invalid arguments |
| 2 | Error | Failed to communicate with TM1 |
| 3 | Error | Command failed to run |
Deactivate a chore
To deactivate a chore, use a Deactivate a chore command.
Properties
| Property | Detail |
|---|---|
| Chore name | Enter the name of the chore to deactivate. |
Outputs
None
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Invalid arguments |
| 2 | Error | Failed to communicate with TM1 |
| 3 | Error | Command failed to run |
Delete a chore
To delete a chore, use a Delete a chore command.
Properties
| Property | Detail |
|---|---|
| Chore name | Enter the name of the chore to delete. |
Outputs
None
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Invalid arguments |
| 2 | Error | Failed to communicate with TM1 |
| 3 | Error | Command failed to run |
Delete a cube
To delete a cube, use a Delete a cube command.
Properties
| Property | Detail |
|---|---|
| Cube name | Enter the name of the cube to delete. |
Outputs
None
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Invalid arguments |
| 2 | Error | Failed to communicate with TM1 |
| 3 | Error | Command failed to run |
Delete a cube view
To delete a cube view, use a Delete a cube view command.
Properties
| Property | Detail |
|---|---|
| Cube name | Enter the name of the cube to delete from. |
| View name | Enter the name of the view to delete. |
Outputs
None
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Invalid arguments |
| 2 | Error | Failed to communicate with TM1 |
| 3 | Error | Command failed to run |
Delete a process
To delete a process in TM1, use a Delete a process command.
Properties
| Property | Detail |
|---|---|
| Process name | Enter the name of the process. |
Outputs
None
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Invalid arguments |
| 2 | Error | Failed to communicate with TM1 |
| 3 | Error | Command failed to run |
Execute a chore
To run a chore in TM1, use an Execute a chore command.
Note: To run a chore manually, don't activate it.
Properties
| Property | Detail |
|---|---|
| Chore name | Enter the name of the chore to run. |
Outputs
None
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Invalid arguments |
| 2 | Error | Failed to communicate with TM1 |
| 3 | Error | Command failed to run |
Execute a process
To run a process in TM1, use an Execute a process command.
Properties
| Property | Detail |
|---|---|
| Process name | Enter the name of the process to run. |
| Process params | Enter the params to run the process with. |
Outputs
None
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Invalid arguments |
| 2 | Error | Failed to communicate with TM1 |
| 3 | Error | Command failed to run |
| 10 | Error | Invalid parameter |
| 53 | Error | The process failed to run |
| 55 | Error | The process failed to run |
Execute MDX
To run a multidimensional expression (MDX) function and export it to a CSV, use an Execute MDX command.
Properties
| Property | Detail |
|---|---|
| MDX function | Enter the MDX function to execute. |
| Output type | Select the format of the generated CSV file. |
Outputs
| Output | Output type |
|---|---|
| Cell data | File |
| Cellset ID | String |
| Total cells processed | Integer |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Invalid arguments |
| 2 | Error | Failed to communicate with TM1 |
| 3 | Error | Command failed to run |
Filter message logs
To list the server's message logs, use a Filter message logs command.
Properties
| Property | Detail |
|---|---|
| Start date | Enter the start date filter for the logs. |
| End date | Enter the end date filter for the logs. |
| Max results | Enter the maximum number of log entries to retrieve. |
Outputs
| Output | Output type |
|---|---|
| Log file | File |
| Log entry count | Integer |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Invalid arguments |
| 2 | Error | Failed to communicate with TM1 |
| 3 | Error | Command failed to run |
Filter transaction logs
To list the server's transaction logs, use a Filter transaction logs command.
Properties
| Property | Detail |
|---|---|
| Start date | Enter the start date filter for the logs. |
| End date | Enter the end date filter for the logs. |
| Max results | Enter the maximum number of log entries to retrieve. |
| Cube filter | Enter the filter criteria for the cube to retrieve transaction logs for. |
| User filter | Enter the filter criteria for the user to retrieve transaction logs for. |
Outputs
| Output | Output type |
|---|---|
| Log file | File |
| Log entry count | Integer |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Invalid arguments |
| 2 | Error | Failed to communicate with TM1 |
| 3 | Error | Command failed to run |
Get process error logs
To retrieve a ZIP file of the process error logs, use a Get process error logs command.
Properties
| Property | Detail |
|---|---|
| Start date | Enter the start date filter for the logs. |
| End date | Enter the end date filter for the logs. |
| Process name | Enter the name of the process. |
Outputs
| Output | Output type |
|---|---|
| Zipped logs | File |
| Log file count | Integer |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Invalid arguments |
| 2 | Error | Failed to communicate with TM1 |
| 3 | Error | Command failed to run |
List chore tasks
To list the available tasks in a chore, use a List chore tasks command.
Properties
| Property | Detail |
|---|---|
| Chore name | Enter the name of the chore to list the tasks of. |
Outputs
| Output | Output type |
|---|---|
| Chore task steps | Array |
| Chore task count | Integer |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Invalid arguments |
| 2 | Error | Failed to communicate with TM1 |
| 3 | Error | Command failed to run |
List chores
To list the available chores, use a List chores command.
Properties
None
Outputs
| Output | Output type |
|---|---|
| Chore names | Array |
| Chore active settings | Array |
| Chore count | Integer |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Invalid arguments |
| 2 | Error | Failed to communicate with TM1 |
| 3 | Error | Command failed to run |
List cube dimensions
To list the dimensions in a cube, use a List cube dimensions command.
Properties
| Property | Detail |
|---|---|
| Cube name | Enter the name of the cube to list the dimensions of. |
Outputs
| Output | Output type |
|---|---|
| Dimension names | Array |
| Dimension unique names | Array |
| Dimension count | Integer |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Invalid arguments |
| 2 | Error | Failed to communicate with TM1 |
| 3 | Error | Command failed to run |
List cube views
To list the views in a cube, use a List cube views command.
Properties
| Property | Detail |
|---|---|
| Cube name | Enter the name of the cube to list the views of. |
Outputs
| Output | Output type |
|---|---|
| View names | Array |
| View count | Integer |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Invalid arguments |
| 2 | Error | Failed to communicate with TM1 |
| 3 | Error | Command failed to run |
List cubes
To list the cubes, use a List cubes command.
Properties
None
Outputs
| Output | Output type |
|---|---|
| Cube names | Array |
| Cube count | Integer |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Invalid arguments |
| 2 | Error | Failed to communicate with TM1 |
| 3 | Error | Command failed to run |
List processes
To list the available processes, use a List processes command.
Properties
None
Outputs
| Output | Output type |
|---|---|
| Process names | Array |
| Process count | Integer |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Invalid arguments |
| 2 | Error | Failed to communicate with TM1 |
| 3 | Error | Command failed to run |
List users
To list the users on the TM1 server, use a List users command.
Properties
None
Outputs
| Output | Output type |
|---|---|
| User unique names | Array |
| User names | Array |
| User types | Array |
| User enabled | Array |
| User actives | Array |
| User count | Integer |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Invalid arguments |
| 2 | Error | Failed to communicate with TM1 |
| 3 | Error | Command failed to run |
Read view cells
To generate a CSV with hierarchies as headers of all cell values in a view, use a Read view cells command.
Properties
| Property | Detail |
|---|---|
| Cube name | Enter the name of the cube. |
| View name | Enter the name of the view. |
| Output type | Select the format of the generated CSV file. |
Outputs
| Output | Output type |
|---|---|
| View data | File |
| Callset ID | String |
| Total cells processed | Integer |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Invalid arguments |
| 2 | Error | Failed to communicate with TM1 |
| 3 | Error | Command failed to run |
Update chore task parameters
To change the parameters set for a given chore task, use an Update chore task parameters command.
Properties
| Property | Detail |
|---|---|
| Chore name | Enter the name of the chore. |
| Task number | Enter the number of the task to update the parameters for. |
| Parameters | Enter the new parameter values for the task. |
Outputs
None
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Invalid arguments |
| 2 | Error | Failed to communicate with TM1 |
| 3 | Error | Command failed to run |
| 10 | Error | Invalid chore task parameter |
| 13 | Error | The chore tasks specified has no parameters |
| 17 | Error | The chore has an active schedule |
Write cube cells
To write values to a cube, use a Write cube cells command. This command requires a comma-separated values (CSV) file with:
- Hierarchy unique names as the headers
- A column header Value, with the values to write to the cube
Properties
| Property | Detail |
|---|---|
| Cube name | Enter the name of the cube. |
| File format | Select the format of the CSV file. |
| CSV file | Enter the CSV source file. |
Outputs
| Output | Output type |
|---|---|
| Cells updated count | Integer |
| Failed cell writes | Integer |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Invalid arguments |
| 2 | Error | Failed to communicate with TM1 |
| 3 | Error | Command failed to run |
| 16 | Error | Some cells failed to write to the cube |