TM1 Tool Config — Project Sheet

The TM1 Tool provides two tools for automating IBM TM1 and Planning Analytics operations. Both include InTouch's fanatical session management that never leaves dangling connections.

1. Run Chore Tool

Execute TM1 chores with automatic session management. Chores are server-side processes that can contain multiple TurboIntegrator processes and are managed through the TM1 server.

Parameter	Description	Required
Connection	TM1 REST connection object (encrypted credentials)	Yes
Chore Name	Name of the TM1 chore to execute	Yes
Timeout	Maximum wait time for chore completion (seconds)	No (default: server default)
Wait for Completion	Wait for chore to finish or fire-and-forget	No (default: wait)

2. Run TurboIntegrator Process Tool

Execute one or more TI processes with dynamic parameter overrides. Run processes sequentially with different parameter values for each — ideal for parameterized data loads and processing.

Parameter	Description	Required
Connection	TM1 REST connection object	Yes
Process Name	TurboIntegrator process name to execute	Yes
Parameters	List of parameter name/value overrides for the TI process	No
Multiple Processes	Execute multiple TI processes in sequence within one tool	No
Timeout	Maximum execution time per process (seconds)	No
Stop on Error	Halt the sequence on first error or continue	No (default: yes)

Session Management

Fanatical Session Management — Never Leaves Dangling Sessions

Dangling TM1 sessions are a critical operational problem. They cause severe server performance degradation, prevent users from logging in, and ultimately force server restarts that disrupt the entire organization.

InTouch manages TM1 sessions with obsessive precision:

Automatic Session Creation

Sessions are created only when needed and authenticated using encrypted credentials from the connection object. No credentials in scripts or config files.

Guaranteed Cleanup

Sessions are properly closed after every operation — whether the tool succeeds, fails, times out, or encounters any error. No exceptions, no dangling sessions.

Error Recovery

Even when TM1 returns unexpected errors or the network connection drops, InTouch ensures the session is properly terminated before exiting.

Timeout Protection

If a process exceeds the configured timeout, InTouch forcefully terminates the operation and still properly cleans up the session.

Connection Configuration

TM1 connections are configured as reusable, centralized objects with encrypted credentials:

REST API Endpoint

TM1 server URL (https://host:port/api/v1)

Authentication

Encrypted username and password

SSL/TLS

Configurable SSL settings and certificate trust

Connection Validation

Pre-execution connectivity test

Access Control

Role-based access determines who can use each connection

Credential Rotation

Update one connection object — all tools use new credentials

Common Configuration

Error Handling

TM1 error codes, process error logs, and TI minor/major error statuses are all captured. Automatic notifications on failure with full diagnostic details.

Scheduling

Trigger TM1 tools on any of 7 native schedule types, file arrivals, API calls, AI triggers, or after upstream tools. Coordinate TM1 operations with SQL loads, file transfers, and other tools.

Logging & Audit

Every execution is logged with timestamps, TI process return codes, parameter values used, and session lifecycle events. Complete audit trail.

Multi-System Orchestration

Chain TM1 tools with SQL Tool, DataFrame, and Essbase tools. Build cross-platform workflows: extract from database, transform, load into TM1.

TM1 Tool Configuration