Planning Analytics

Microsoft Windows 2019 server


How install tm1py to server that is not connected to internet?


Download python to your laptop and to the server, and install python on both.

Run the python-3.11.3-amd64.exe to install the software.

Select Customize installation. (ensure you click “add python to path” )

Click Next

Select install python for all users, and change the path to a simpler one outside program files.

Click Close when done.

On your laptop (that is connected to internet) go to your python folder. Inside the command prompt enter:

pip install tm1py[pandas]

When done – run below command, to ensure you have the requirements:  (

pip install requests_negotiate_sspi

Create the folder c:\temp\offline. Move to that folder in command window and run the command:

pip freeze > C:/temp/offline/requirements.txt

Zip all the needed files with this command (run the command from the folder where you want the zip files to be created):

pip download tm1py[pandas]

The versions above listed, depend on the version you have installed of python and tm1py. You may get different versions.

If you get errors later, in most cases, it is because we have not succeeded to get the right files to this folder.

Now copy the files over to the server from the laptop. (copy all files to the same folder)


Above a example of the req.txt file content for tm1py needed files.

Copy the whl files in c:\python311\scripts over to the servers c:\python311\scripts folder (or the folder you are using like c:\temp\offline).

If you copy between virtual machines, in vbox, you access the local host drive with \\Vboxsvr\c_drive\temp.

How to create shared folder for virtual machine on VirtualBox

It is important that the files are in the same folder, otherwise you get:

C:\Python311\Scripts>C:\Python311\scripts\pip install –no-index –find-links C:/temp/offline -r requirements.txt
ERROR: Could not open requirements file: [Errno 2] No such file or directory: ‘requirements.txt’

C:\temp\offline>C:\Python311\scripts\pip install –no-index –find-links C:/temp/offline -r requirements.txt
Looking in links: c:/temp/offline
ERROR: Could not find a version that satisfies the requirement certifi==2022.12.7 (from versions: none)
ERROR: No matching distribution found for certifi==2022.12.7

C:\Python311\Scripts>C:\Python311\scripts\pip install –no-index –find-links -r requirements.txt
Looking in links: -r
WARNING: Location ‘-r’ is ignored: it is either a non-existing path or lacks a specific scheme.
ERROR: Could not find a version that satisfies the requirement requirements.txt (from versions: none)
HINT: You are attempting to install a package literally named “requirements.txt” (which cannot exist). Consider using the ‘-r’ flag to install the packages listed in requirements.txt
ERROR: No matching distribution found for requirements.txt

C:\Python311\Scripts>C:\Python311\scripts\pip install –no-index –find-links c:\python311\scripts -r requirements.txt
Looking in links: c:\python311\scripts
Processing c:\python311\scripts\certifi-2022.12.7-py3-none-any.whl
Processing c:\python311\scripts\charset_normalizer-3.1.0-cp311-cp311-win_amd64.whl
Processing c:\python311\scripts\idna-3.4-py3-none-any.whl
Processing c:\python311\scripts\ijson-3.2.0.post0-cp311-cp311-win_amd64.whl
Processing c:\python311\scripts\mdxpy-1.2.tar.gz
Installing build dependencies … error
error: subprocess-exited-with-error

× pip subprocess to install build dependencies did not run successfully.
│ exit code: 1
╰─> [3 lines of output]
Looking in links: c:\python311\scripts
ERROR: Could not find a version that satisfies the requirement setuptools (from versions: none)
ERROR: No matching distribution found for setuptools
[end of output]

note: This error originates from a subprocess, and is likely not a problem with pip.
error: subprocess-exited-with-error

× pip subprocess to install build dependencies did not run successfully.
│ exit code: 1
╰─> See above for output.

note: This error originates from a subprocess, and is likely not a problem with pip.

Enter -vvv last to get more information about the issue;

pip install –no-index –find-links c:\python311\scripts -r requirements.txt -vvv

Maybe a solution, check what files you get issues with, if it is the files that end with tar.gz, then search on the laptop you have it installed on to find the whl file for the same function.  Search for mdxpy* if you get error at mdxpy-1.3.2.tar.gz.

You will find the file in a folder like C:\Users\Administrator\AppData\Local\pip\cache\wheels\f8\6d\90\4bfbb1a9cc872dbc6e440d1f4ec64cb896cc724e3a9d29fc92

copy the file mdxpy-1.3.2-py3-none-any.whl to the folder where you have the other files you need. (like c:\temp\offline)

Repeat for file TM1py-2.0.4-py3-none-any.whl, so you get a whl file from the cache to the other computer and place in the folder where you install from.

Try then again with the command similar to this:

c:\python312\scripts\pip install --no-index --find-links C:\tempd -r c:\tempd\req.txt

The clue is to have all the whl files you need in the folder where you install the things from.

If you get;

ERROR: Could not open requirements file: [Errno 2] No such file or directory: ‘requirements.txt’

Try this command after you copy the txt file to the scripts folder

C:\Python311\Scripts>pip install --no-index --find-links c:\python311\scripts -r requirements.txt -vvv


You can try to edit the txt file to have the number listed in the error, gives that the error goes away, but you get a new error.

C:\tempas>pip install –no-index –find-links c:\tempas\ -r requirements.txt
Looking in links: c:\tempas\
Processing c:\tempas\certifi-2023.11.17-py3-none-any.whl
Processing c:\tempas\charset_normalizer-3.3.2-cp311-cp311-win_amd64.whl
Processing c:\tempas\idna-3.6-py3-none-any.whl
ERROR: Could not find a version that satisfies the requirement ijson==3.2.0.post0 (from versions: 3.2.3)
ERROR: No matching distribution found for ijson==3.2.0.post0

When you try to install several times to the same computer, think that the pip program will load files from the local cache folder first, and therefor the installation can fail – even you are writing the correct command to do the work.


== The last Solution to try are below ==

To repeat the steps you need to do to install a python package on a air-gapped computer:

On the computer where you have internet contact;

Install the latest python package (python-3.12.4-amd64.exe ), install the same package on the air-gapped computer.

Ensure that during installation you select, install for all users and add to path. Then go to the command prompt and run:

pip install tm1py[pandas] streamlit

pip freeze > c:/tempe/req.txt

Go to the tempe folder and run below command

pip download streamlit

pip download tm1py[pandas]

Here you get the gz file, but it looks like you need the whl file. Copy that from the cache to the c:\tempe folder. You may need these files:




So you have all needed whl files in the folder. The version number can be different if you install a different version of tm1py.

Copy the \tempe\ folder over to the air-gapped computer and run command:

c:\python312\scripts\pip install  --no-index  --find-links  C:\tempe  -r  c:\tempe\req.txt

Hopefully it works easier for you to do the installation on your computer. (Below when the pip command works fine).

To check if tm1py is installed enter: pip show tm1py

Name: TM1py
Version: 1.10.2
Summary: A python module for TM1.
Author: Marius Wirtz
License: MIT
Location: C:\Python311\Lib\site-packages
Requires: ijson, mdxpy, pytz, requests, requests-negotiate-sspi

How the latest ( ) python install package steps look like:

More information:

Share Folders between Host and Guest OS in VirtualBox

Add python to path by using the keyboard shortcut (Win+Pause) to get to settings and under advance link, click on “Environment Variables” button.

You can install streamlit via pip:

pip install streamlit

Once streamlit is installed, let us create a very basic web app.

As the first step, let us create a new Python script. Let us call it

Open in your favourite IDE or text editor, then add these lines:

import streamlit as st

st.title("I love TM1py")

With that in place, we can run Streamlit from the command line:

Planning Analytics Workspace 95
Microsoft Windows 2019 server


In PAW administration page, for the agents, the version number is not showing the PAA agent version installed.


When you have installed PAA_Agent version 95. By command similar to this:

UpdatePAAAgent.bat “D:\Program Files\ibm\cognos\tm1_64”


This value is from the file D:\Program Files\ibm\cognos\tm1_64\paa_agent\paaAgentCache\serversInfo.json

Test to erase the folder D:\Program Files\ibm\cognos\tm1_64\paa_agent\paaAgentCache in your lab environment, before you install the paa-agent, to see if that solves the issue. In most cases this does not work, and you have to reinstall PAL.

Our guess is that the different version of PAA Agent use different scripts/folders and therefor this file is not correct updated.



More Information: 



Planning Analytics
Microsoft Windows 2019 server

We change the password for the system account that we use when calling TI processes inside TM1 instances, and now Tm1RunTi.exe does not work.


Find the file that contain the password and key, run below command to create the new password files:

tm1crypt.exe  -keyfile  d:\arkiv\CognosUser_key.dat  -outfile  d:\arkiv\CognosUser_cipher.dat  -validate

(above will create the files in the folder d:\arkiv\, then you have to copy them to correct folder that you referee in your code)

You have to enter the new password for your service account twice.

# Parameters

sQuote = Char(34);

sRunTIPath=sQuote |'D:\Program Files\ibm\cognos\tm1_64\bin64\\TM1RunTI.exe'|sQuote ;
sPasswordFile=sQuote |'D:\TM1 data\Tm1_Trigger\'|sPwdFile|sQuote ;
sPasswordKeyFile=sQuote |'D:\TM1 data\Tm1_Trigger\'|sPwdKeyFile|sQuote ;
sUser=sQuote | sUserName | sQuote ;
sProcess = sQuote | pProcessName | sQuote ;

# Execute Command

sCommand = sRunTIPath | ' -Process ' | sProcess | ' -Adminhost ' | sAdminHost | ' -Server ' | sInstance | ' -CAMNamespace ' | sNameSpace |
' -User ' | sUser | ' -passwordfile ' | sPasswordFile | ' -passwordkeyfile ' | sPasswordKeyFile ;
ExecuteCommand(sCommand , 0 );


Above in a prolog dialog will execute the TM1runTI.exe with the parameters you provide for TI process ( pProcessName ) to run and TM1 instance (pInstance) to use.

You need to update above TI code with the correct windows server name and Active Directory domain name, also point to the correct folder where you save the dat files, and the windows user account that you use for the access to the tm1 models.


More Information:


Planning Analytics
Microsoft Windows 2019 server
Planning Analytics Workspace version 95


Where is the files uploaded to?

When you try to create a new folder in PAW version  95, then you get a error like below, then something with the installation went wrong.

The following administration agent error occurred – {“errorMessage”:{},”query”:”/pakate-agent/v0/filemanager/Planning%20Sample/files”,”httpStatusCode”:500}


The file manager will only access a folder under your applications data folder called model_upload like in C:\Program Files\ibm\cognos\tm1_64\samples\tm1\PlanSamp\model_upload. (i think you can edit this folder name in the paa-agent file.)  Try change this value:


To upload a file go to PAW and WORKBENCH

Right click on the application you want to work with files and select file manager.

Click on the upload icon, and then drag the file to the area, and press upload button.

When the file is uploaded, close above dialog.

The file is put in a folder below your data folder, for your tm1 instance.



If the paa-agent not work as expected, then the files are created here, for all tm1 instances.

D:\Program Files\ibm\cognos\tm1_64\paa_agent\wlp\usr\servers\kate-agent\model_upload

Check the messages.log file above for more information why it does not work.

Reinstall PAA agent, for you to try resolving the issue.

The problem could be related to one or more old files in the paa_agent folder structure, test below steps.
1. Stop the “IBM Planning Analytics Administration Agent” service
2. Remove the the cache folders: “.logs” and “.classCache” in ../tm1_64/paa_agent/wlp/usr/servers
3. Remove the folder: “workarea” in ../tm1_64/paa_agent/wlp/usr/servers/kate-agent
4. Restart the “IBM Planning Analytics Administration Agent” service
Wait 5 minutes time as the Agent starts, before you test again.
Do not Remove the D:\Program Files\ibm\cognos\tm1_64\paa_agent\paaAgentCache folder, as it looks that it corrupts the PAA agent installation.

More Information: 

Working with files and folders in File manager

​You can use the toolbar to create folders and sub-folders, upload files, refresh files, and search for a folder or file. Use the Actions button Actions button​ or select a file or folder to access options​such as Download, Delete, Cut, Copy, and Compress.

Deleting a file or folder
To delete an item, select the file or folder and click Delete. You can also click the Action button for the item and click Delete.

Warning: When you delete a folder or sub-folder, all files within that folder are also deleted.
Cut, copy, and paste files
You can move or copy files or folders to a different folder within the File manager. The Cut and Copy options are available from the Actions button or display in the toolbar when you select one or more items.
To cut or copy, select one or more items and click Cut or Copy. Your selections display in alphabetical order as a horizontal list for a quick review before you cut or copy the items.
Selected files for cutting or copying display in the File manager
After you review the list of items that you want to cut or copy, you can paste the items to a different folder. To paste a cut or copied item, go to the destination folder and click Paste.
Compress and expand files
Select one or more files or folders and click Compress to compress the items into a .zip file. You can compress a file and move it to a new location without using Cut. To do this, select a file and click Compress. Then, go to the destination folder and click Compress again.
To expand a compressed file, select the file and click Expand. As with compressing a file to a new location, you can expand a file to a new folder.


Planning Analytics
Microsoft Windows 2019 server
Microsoft® Excel® for Microsoft 365 (Version 2308 Build 16.0.16731.20542) 64-bit


When using the drill function in TM1 Perspective, you get a error, if you do the same task in a different version of TM1 Perspective it works.

Excel crash, and then restarts recovering your xls file. The drill down does not work.


Install and use a different version of TM1 Perspective.

The issue started with version and was first solved with version of TM1 Planning Analytics Perspective.

So if you use TM1 Perspective with 64 bit excel, you do not have a issue.

Or if you use TM1 Perspective with 32 bit excel, you should also be fine.

Planning Analytics is the last release to include 32-bit versions of the TM1 clients (Architect and TM1 Perspectives).

More Information:

Determine the version of IBM Planning Analytics (

Using the Drill option in 64-bit IBM Cognos TM1 Perspectives causes an “Excel Stack Exceeded” error.

IBM Planning Analytics 2.0 Fix Lists

IBM Planning Analytics – Setting up Basic DRILL THROUGH Functionality – QueBIT

Drill through cells to see detailed data – IBM Documentation

Planning Analytics
Microsoft Windows 2016 server

The security scan program reports that the port 12345 is not secure. Cause ssl-cve-2016-2183-sweet32 issue.

Possible solution:

Try to implement this limit in the ciphers that TM1 internally can use for communications.

Login to the PAL (planning analytics) server as admin.

Stop TM1 admin service and all the other TM1 instance services.

Open Cognos Configuration for TM1.

Add below to Supported ciphersuites:



Then open each TM1S.CFG file for each instance, and add below last in the file:



Save the file.

Start the TM1 Admin service first, and then the other TM1 instances one by one.

Check that you can login.

Wait and see if the security scan report a problem less.

More Information: 


Planning Analytic in containers (v12)


Can i write to a file share from a Tm1 TI process?


No, you can not use the old TI command ASCIIOUTPUT

The solution, i guess. is that you need to have a external script (tm1py) that get the data to file by doing HTTP REST API calls to the Planning Analytics installation.

This command only access the tm1 instance data folder in v12 of Planning Analytics.

TurboIntegrator function changes

The following TurboIntegrator file functions now work only with files in the database content directory or its child directories:

  • AsciiDelete
  • AsciiOutput
  • AsciiOutputOpen
  • FileExists
  • SetOutputEscapeDoubleQuote
  • TextOutput
  • WildcardFileSearch


Going from v11 to v12, you have to rewrite code that access the file system.

How to do things in the new version of Tm1 is mostly found in the community……

More Information:

Planning Analytics Engine (v12) does not support the C, Java, .Net, and all internal and experimental versions of the REST API. Only the OData compliant REST API is supported for interaction with the Planning Analytics Engine database.

Because older APIs are no longer supported, clients such as Architect and Perspective, do not work with Planning Analytics Engine.

The following TurboIntegrator functions are not supported in Planning Analytics v12 Engine:

LockOff LockOn
SaveDataAll ServerShutdown

Example of write to PAL using TM1PY

Planning Analytics 2.0.9.x
Microsoft Windows 2019 server

Can i prevent user from change the transaction log files?

That is the default – tm1 admin and users can not change the transactions log file from inside Planning Analytics (Tm1 architect).

You must have direct access to the TM1 server and the logg folder, and you can only change the file when the TM1 instance is stopped.

If you do not allow people access to the windows server disk – then the files can not be tampered with.

The transactions log can be read and search from inside TM1 architect, or PAW.

The following information is recorded in the tm1s.log file:

Date and time the change was made
Name of the client who made the change
Whether the new data is simple data (N) or string data (S)
Value before the change
Value after the change
Name of the cube in which the change was made
Elements that identify the cell that changed

More Information:

  • Transaction logging can be enabled and disabled for specific cubes by setting the LOGGING column in the }CubeProperties cube. Transaction logging is typically needed on cube transactions only during period of manual user data entry. For more information, see Enabling and disabling transaction logging.
  • The current transaction log file is named tm1s.log. The tm1s.log file is locked by the TM1 database and cannot be viewed or edited with a text editor. The current transaction log file is renamed to tm1s<timestamp>.log during a SaveDataAll (SaveDataAll happens automatically on shutdown or restart). An empty tm1s.log file is generated when the TM1 database starts and during a SaveDataAll without a database restart. For more information, see SaveDataAll.
  • The tm1s timestamped files, can be moved to other storage area for secure storage, if they are needed for later analysis.
  • If the server is intentionally shut down without saving the changes, the log file is saved with a timestamp and the extension is changed to .rej. You can process the tm1s<timestamp>.log file through TurboIntegrator to recover the transactions.
  • During an improper server shutdown, the tm1s.log remains as is and is not timestamped during shutdown. When the server restarts, it recognizes the presence of an old tm1s.log file and prompts you to choose between recovering the new log from the old existing log.
  • By default, TM1 logs transactions to all cubes loaded on the server. As the system administrator, you have the option to turn off logging for particular cubes. When you disable logging, TM1 accelerates updating the data but you cannot recover the updates in the event of a system failure. 

The transactions log – IBM Documentation

Planning Analytics TM1
Microsoft Windows 2019 Server


When user browse to the tm1web they get a error – random in different web-browsers e.g. chrome and edge.

Error msg:

This site can’t provide a secure connection sent an invalid response.
Try running Windows Network Diagnostics.


Check the URL you use – it need to start with HTTP:// if you do not have a certificate on your TM1WEB service.

If you by accident enter;

you get above error.

You need to enter


More Information:



Planning Analytics Tm1 Perspective

Microsoft® Excel® for Microsoft 365 MSO 64 Bit


How add TM1 Perspectiv to always be started with Excel?


After you have installed TM1 Perspective from tm1client_winx64h_2.0.919.10_ml.tar

Start Excel

Go to file – options

Click on Add-ins

Click GO at Manage Excel add-ins

Click Browse

Go find the file C:\Program Files\IBM\cognos\tm1_64\bin64\tm1p.xla

Click OK.

Now it should look like above.

Press OK.

Close Excel.


More Information: