How setup TM1 IDE

Product:
Planning Analytics  TM1_version=TM1-AW64-ML-RTM-11.0.913.10-0

Windows Server 2019

Issue:

There are more than one IDE for TM1 now. How do I setup the browser based?

https://github.com/falconbi/tm1_ide

Solution:

On your windows laptop install node.js  – download the msi from https://nodejs.org/en/download 

Install the node-v24.18.0-x64.msi program to folder C:\Program Files\nodejs

Start powershell as administrator

Create a folder like IDE, go to that folder and enter below command:

git clone https://github.com/falconbi/tm1_ide.git

go to the new folder
cd tm1_ide

Remove security in powershell with command

Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy RemoteSigned

Run below to install

npm install

For native TM1 access, ensure the HTTPPortNumber are set in tm1s.cfg for your applications. If you use Admin with password apple, ensure that account exist in all your TM1 applications with the same password.

Go to folder  C:\ide\tm1_ide\config and create the text file servers.json in notepad++

Enter below text, and adjust it to your ip number to your TM1 server, and the user and password to use.

{
"adminHosts": [
{
"name": "MyLab",
"url": "http://192.168.1.220:5895",
"adapter": "direct-v11",
"loginServer": "proven_techniques",
"username": "admin",
"password": "apple",
"servers": ["24Retail", "proven_techniques"]
}
]
}

At servers row, list all the TM1 server you should access.

The port 5895 is for the TM1 admin service, that the IDE will talk to first.

Go to tm1_ide folder and copy file .env.example to .env

In the C:\ide\tm1_ide change the .env file to only contain one row

The port 8083 is the port the client will use for you to access it.

From powershell to start IDE enter

npm start
Start your chrome browser and go to  http://localhost:8083

There you are with a new tool to edit TM1. There are a few to select from now – both free and paid for.

 

More Information from the different IDE:

https://cubewisecare.atlassian.net/wiki/spaces/AIAC1/overview

https://marketplace.visualstudio.com/items?itemName=TimGeilen.pa-code

https://github.com/bgregs514/tm1_ide

TM1 IDE has been replaced by vscode-tm1, a Visual Studio Code extension for TM1. While many of the ideas from this project have been carried forward into vscode-tm1, this project has been deprecated and will be left here for reference.

Old Description

Still pending official name – for now TM1 IDE will be used. The goal of TM1 IDE is to implement a development environment with a desktop feel for both rules and processes. With the onset of the IBM provided Rest API, there has been a proliferation of web-based editors, but nothing that provides a true native experience for the more traditional developer. This project aims to cut through the feature overload that has become increasingly popular, and provide the average developer with a simple, clean interface that stays out of their way.

How to use

Ensure NodeJS/npm is installed.

Open a shell (Powershell in this example) and run the following after cloning to install project dependencies:

npm install
Then run the following to start the applicaton:
npm start
Architecture
  • Electron for desktop experience
  • NodeJS for core logic and integration
  • Monaco for the development area

https://open-vsx.org/extension/flamey3t1/vscode-tm1-ide

TM1 IDE — The Complete IDE for IBM Planning Analytics / TM1

Author: flameY3T1

TM1 IDE turns VS Code into a full development environment for IBM Planning Analytics / TM1. Write TI processes and rules with real autocomplete and a server-backed compile check, browse and edit cubes and dimensions visually, run MDX, trace process call graphs, test processes without touching your data, and mirror everything to Git — all from one tree, across as many servers as you like.

If you’ve been switching between Architect, PAW, and a text editor, TM1 IDE replaces all three with a single, modern, keyboard-driven workflow. No prior VS Code experience required — this guide gets you running.


Why TM1 IDE

Most TM1 editors stop at “edit a process, push it back.” TM1 IDE goes further:

  • Visual cube & dimension editing — pivot cubes, write back values, spread, and restructure hierarchies by drag-and-drop. Not just code.
  • Server compile-check on save — bad code never reaches the server. The save is blocked, not silently broken.
  • Configurable linter + formatter — per-server rule sets and severities: strict on Prod, relaxed on Sandbox.
  • Call-graph & references — see the blast radius of a process before you change it.
  • Git mirror — materialize processes and rules as files, with drift detection and diff.
  • Fully localized — complete English and German UI.

Getting Started

Step 1 — Install

  1. Open your favorite IDE (VS Code, Kiro, …).
  2. Open Extensions (Ctrl+Shift+X), search for “TM1 IDE”, click Install.
  3. Fully restart the IDE — a window reload is not enough.

A new TM1 Explorer icon appears in the activity bar — your main entry point.

https://www.tm1forum.com/viewtopic.php?t=15666

https://github.com/bgregs514/vscode-tm1/discussions/33

https://github.com/falconbi/tm1_ide

The Browser version of TM1 IDE

For environments where TM1 is accessed through PAW, do below steps to connect:

cp .env.example .env
Edit .env:
PAW_HOST=http://192.168.x.x
PAW_USERNAME=admin
PAW_PASSWORD=your_password
PAW_LOGIN_SERVER=Production
PORT=8083

# Optional: AI-powered MDX generation
ANTHROPIC_API_KEY=sk-ant-...
Edit config/servers.json:
[
  { "name": "Production" },
  { "name": "Development" }
]

See Authentication for multi-host and advanced adapter setups.

3. Run

 

npm start

Root cause: PAW validates all logins against one specific TM1 server — the TM1 Login Server — configured in PAW Admin Console → Configuration → TM1 Login Server URI. Users created on any other server are invisible to PAW auth.

Fix shipped:

  • Added PAW_LOGIN_SERVER to .env and .env.example
  • All 10 user/group routes in server.js now always target PAW_LOGIN_SERVER regardless of selected workspace server
  • README updated with new “PAW Login Server” section

V12 note: TM1 Login Server is a V11-only concept. User management in the IDE must be adapter-aware — disabled or routed to IdP on V12/OIDC environments.


2. PAW Architecture — Key Facts

 

  • PAW is not a separate user store — in TM1 native auth mode, TM1 }Clients IS the user store
  • PAW has one designated TM1 Login Server for auth — all logins validated there (V11 only)
  • PAW discovers TM1 servers via the TM1 Admin Host (port 5895 HTTP / 5898 HTTPS) — a separate service acting as a server registry. TM1 servers register themselves on startup
  • PAW V12 replaces the TM1 Login Server concept with OIDC — identity comes from the IdP, not }Clients
  • The TM1 Login Server constraint is V11-only

Admin Host discovery API (direct, reliable):

GET http://{adminhost}:5895/api/v1/Servers
GET https://{adminhost}:5898/api/v1/Servers

Source: TM1 Admin Server API

PAW proxy list API (unreliable):

GET {paw-host}/api/v1/tm1/Servers

Included in the IBM Postman collection but explicitly noted as “not exposed through the PAW proxy”. Do not depend on this without testing on your instance. tm1_paw_tree documents: “PAW has no endpoint to list TM1 server names”.


3. Arc vs Our IDE — Connection Model

 

Arc connects directly to TM1 via the Admin Host, bypassing PAW entirely. For IBM Cloud / AWS, Arc uses IBM IAM API keys → Bearer tokens — direct Admin Host is blocked by cloud firewalls.

Key discovery: the TM1 OData path suffix is identical across all deployment types:

{base}/api/{pawVersion}/tm1/{database}/api/v1/{endpoint}

Only the auth mechanism, base URL, and PAW API version prefix change. Our existing PAW-proxy architecture is the right shape — it just needs pluggable auth underneath.

Read more in there documentation.

https://marketplace.visualstudio.com/items?itemName=CarpeDatum.tm1-helper 

https://github.com/falconbi/tm1_ide/blob/main/docs/REST%20API%20README%20.md

https://marketplace.visualstudio.com/items?itemName=tm1-oss.rest-client-tm1-dev

https://code.cubewise.com/software/products/arc/

https://workspace.google.com/marketplace/app/teamone/112725458607

https://omnitm1.com/

https://github.com/ACG-Code/ACG-Utilities-for-IBM-Planning-Analytics

https://getgreenshot.org/

https://marketplace.visualstudio.com/items?itemName=flameY3T1.vscode-tm1-ide

https://marketplace.visualstudio.com/items?itemName=TimGeilen.pa-code