TM1 Tool
IBM Cognos TM1 / Planning Analytics automation via the TM1 REST API.
Tool ID
tm1
Credential Required
Yes — TM1 server connection.
Credential Properties
| Property | Type | Default | Description |
|---|---|---|---|
server |
string | — | Required. TM1 server hostname |
port |
integer | — | Required. TM1 REST API port (HTTPPortNumber from tm1s.cfg) |
login |
string | — | Required. Username |
password |
string | — | Required. Password |
https |
boolean | false |
Use HTTPS |
authMode |
string | basic |
Required. Authentication mode: basic (TM1 native) or cam (Cognos Access Manager) |
namespace |
string | — | CAM namespace (required when authMode is cam) |
Authentication Modes
- basic — Standard TM1 native authentication (Base64 encoded
user:password) - cam — Cognos Access Manager (Base64 encoded
user:password:namespace)
Operations
Task Configuration
All operations use a single objects array containing chores and/or processes to execute sequentially:
| Property | Type | Default | Description |
|---|---|---|---|
objects |
array | — | Required. List of TM1 objects to execute |
Each object in the array:
| Property | Type | Description |
|---|---|---|
objectType |
string | Required. Chore or Process |
object |
string | Required. Chore or process name |
parameters |
array | Process parameters (ignored for chores) |
Process parameters:
| Property | Type | Default | Description |
|---|---|---|---|
name |
string | — | Parameter name |
value |
string | — | Parameter value |
type |
string | String |
String or Numeric |
Operation Types
Chore — Executes a TM1 chore via POST /Chores('{name}')/tm1.Execute
Process — Executes a TurboIntegrator process via POST /Processes('{name}')/tm1.Execute with optional parameters
Available Operations (via getModelNames)
chore— Execute choresprocess— Execute TI processeslist-processes— List available processeslist-chores— List available choresserver-info— Query server configuration
Published Outputs:
- objectsExecuted — total objects executed
- object_N_type — type of Nth object (Chore/Process)
- object_N_name — name of Nth object
- object_N_status — status of Nth object (success)
Killable
Yes — logs out and closes the session.
Technology
Java 11 HttpClient against TM1 REST API v1. Session-based authentication with cookie persistence.
Chaining Patterns
- TM1 process → Email — run a TI process, notify on completion
- SQL export → TM1 process — export data, trigger TI process to load it
- TM1 chore + TM1 process — run a chore then a process in sequence (single task, multiple objects)
- FTP upload → TM1 process — upload data file, trigger TI to process it
Use Cases
- Automated data loads via TI processes
- Scheduled chore execution
- Cube calculation triggers
- Multi-step ETL: export from source → FTP to TM1 server → trigger TI process
- Environment refresh: run multiple processes in sequence
Error Handling
- Authentication failures reported with auth mode context
- Each object execution is reported individually
- Process parameter type mismatch: Numeric values parsed as Double
- HTTP status codes outside 200-299 trigger failure with response body excerpt
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
objectsExecuted
Fields not documented above
Generated from this tool's own schema and published outputs on 2026-09-03. A field the README omits is discoverable only by reading the source, and a published key nothing documents is a capability nobody can reference.
| Field | Type | Description |
|---|---|---|
readTimeoutMinutes |
integer | HTTP read timeout in minutes (default 2, increase for long-running processes) |