Planning Analytics 2.0.9
Microsoft Windows 2019 server


How read in the dimension elements and hierarchy from a text file?


Create a csv file where you have on every row one element, and all its sub-elements before it.

In our example we have a 4 sub-element deep dimension.

You have to use your name of the elements in the dimension.

Create a new TM1 TI process, that take parameters for the dimension to update and where the file is located.

Pick up the file in Data Source tab, and setup the variables as “other”.

Variable names could be of that kind that it is easy to understand what they show.

Create a proplog code to get the dimension or the path from a cube if the parameters is blank:

sSubset = '$.'|getProcessName();

# if parameter is blank - get value from sys cube
IF ( LONG (pDim) <= 0 );

# get the values from sys settings cube
pDim = cellgets('sys.Settings','DimtoUpdate','Value');
pPath = cellgets('sys.Settings','FiletoImport','Value');


# set the values from parameters
sDim = pDim ;
DataSourceNameForServer = pPath ;
DataSourceNameForClient = pPath ;

# set the format of the file
DatasourceASCIIQuoteCharacter = '';
DatasourceASCIIDelimiter = ';'; 


Create in metadata section, that insert the elements into the dimension:



There is more ways to do this – but this is maybe the simplest way.

More Information: 

Catalogue your dimension creation processes in Cognos TM1 


Cognos Controller 11.0.1


Do you have a checklist of what is needed to do a upgrade to Cognos controller 11?


Best is if you create a own checklist for your environment, that you can use at every upgrade. Below is a suggested starting point, that you can develop further.

Download from here: 

Downloading IBM Cognos Controller 11.0.1 


Parts and platforms Details eImage
IBM Cognos Controller 11.0.1 Microsoft Windows Multilingual Required M0DH2ML
IBM Cognos Analytics Client Multiplatform Multilingual Optional M0BRXML
IBM Cognos Analytics installer 3.6.46 Microsoft Windows Multilingual Optional M0BRWML
IBM Cognos Analytics Server Microsoft Windows Multilingual     Optional M0BRVML


You must download the RTM program and then the fix packs.

IBM Cognos Controller 11.0.x Fix List 

IBM Cognos Analytics Fix Lists 

analytics-installer-3.7.21-win.exe (174.73 MB) (1.49 GB) (6.98 GB)

Get file up_cntrl_winx64h_11.0.1200.36_ml.tar.gz that is for Cognos Controller 11.0.1 fix pack 2.

Detail upgrade instruction here: 

Upgrading IBM Cognos Controller – IBM Documentation 

Installing fix packs – IBM Documentation 

Cognos Analytics 11.2.4 can be installed on top of CA 11.1.7.  The installation will overwrite the images folder, and upgrade the content-store database to a different schema version that will not work with the old CA11 version, therefore you must take a backup of the SQL database before.
Cognos Analytics 11.1.x end of support (EOS) is 2024-04-30 – but you can buy extended support.

Cognos Controller 11 needs to be installed fresh. You need to uninstall and remove the old version of CC 10 on your server before you install Cognos Controller 11.
Cognos Controller 10.4.2 end of support (EOS) is 30-Sep-2024.  Lifecycle policy Standard (S): minimum 3 years support with extension of 2 years.

Cognos Analytics upgrade  (if you decide to upgrade Cognos Analytics) Date
Copy the media to local hard disk on server d:\install
Export configuration from cognos configuration to backup folder d:\temp\backup
Backup the CA11 images folders and any custom images folders you use like D:\Program Files\ibm\cognos\analytics\webcontent\bi\images or D:\Program Files\ibm\cognos\analytics\webcontent\bi\samples\images 
Backup the controller config file D:\Program Files\ibm\cognos\analytics\templates\ps\portal\ variables_CCRWeb.xml 
Backup PA variables_TM1.xml files from D:\Program Files\ibm\cognos\analytics\templates\ps\portal
Backup PA planning.html and PMHub.html files from D:\Program Files\ibm\cognos\analytics\webcontent
Backup PA tm1web.html files from D:\Program Files\ibm\cognos\analytics\webcontent\bi\tm1\web 
Backup web.config from D:\Program Files\ibm\cognos\analytics\webcontent
Backup the SQL database for content store
Backup the SQL database for audit
Take a screenshot of cognos configuration environment page
Take a screenshot of the members of cognos administrator group
Take a screenshot of the members of cognos controller administrator group
Take a screenshot of the members of cognos controller user group
Check that firewall ports are open Port 25, 80, 9300, 9362, 1433, 389 etc for BI.  
Stop the Cognos Services
Run the setup program from IBM Cognos Analytics Server
Run the setup program from ( CA 11.2.4 FP3)  
Open Cognos Configuration and click save  
Ensure the SQL driver is in the folder D:\Program Files\ibm\cognos\analytics\drivers  
Start the Cognos BI service
Check that you can login to IBMCOGNOS
Check file exist in D:\Program Files\ibm\cognos\analytics\templates\ps\portal\ variables_CCRWeb.xml 


When CA11 is up and running, then you can install Cognos Controller.

Cognos Controller 11 upgrade Date
Copy media to server d:\install
Backup all Controller database in SQL server
Export configuration from cognos configuration to backup folder d:\temp\backup
Backup the acl files in D:\Program Files\ibm\cognos\ccr_64\ControllerProxyServer 
Backup the web.config file in D:\Program Files\ibm\cognos\ccr_64\ControllerProxyServer
Take screenshots of application pools and iis timeout settings
Take screenshots of every setting in Cognos Controller configuration
Backup all under D:\Program Files\ibm\cognos\ccr_64\fcmweb
Backup all under D:\Program Files\ibm\cognos\ccr_64\frontend
Backup the udl files in D:\Program Files\ibm\cognos\ccr_64\Data 
Backup properties file from D:\Program Files\ibm\cognos\ccr_64\server\FAP
If HTTPS is used, backup all certificate stores
Stop all IBM Cognos Controller services
Uninstall the previous version of Cognos Controller
Reboot the server
Install the new version of Cognos Controller 
Stop Internet Information Services (IIS) Manager (the Default Web Site)

Stop IBM Cognos Controller Consolidation

Go to the folder C:\Program Files\ibm\cognos\ccr_64

Search recursively for all instances of the subfolder workarea.

Delete all instances of the workarea folder that appear in the search results.

Install the new fix pack of Cognos Controller
Place the SQL driver sqljdbc42.jar in D:\Program Files\ibm\cognos\ccr_64\server\integration 
Place the SQL driver sqljdbc42.jar in D:\Program Files\ibm\cognos\ccr_64
Add back the information in Cognos Controller configuration and click save
Create the virtual directories in WWW for Cognos Controller 
Update the files for Controller Web with old information
Upgrade your Controller application databases
Create a UDL file and Upgrade your FAP database
If FAP service is on other server, install FAP there
Add back the file
Upgrade the Cognos Controller client on the server – can you login?
Start FAP service – any error in log file?
Create the Cognos Controller Client package for silent installation
Reboot windows server and check you can login to cc

More information:

Planning Analytics
Microsoft Windows 2019 server


Do you have a checklist to help out with the upgrade/installation of Planning Analytics?


Best is if you create a checklist that cover the needs of your environment, but here is a suggested to be used as a starting point.

Download from here: 

Detail upgrade instruction here: 


Action Date
Copy the media to local hard disk on server d:\install
Export configuration from cognos configuration to backup folder d:\temp\backup
Backup samples folder D:\Program Files\ibm\cognos\tm1_64\samples\tm1
Backup the tm1web_config.xml for TM1WEB from:

D:\Program Files\ibm\cognos\tm1web\webapps\tm1web\WEB-INF\configuration

Backup server.xml and jvm.options and files from folder:

D:\Program Files\ibm\cognos\tm1web\wlp\usr\servers\tm1web

Backup of your PAA Agent file in folder:

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

Export the TM1 applications as a backup – the data is saved in the TM1 data folder.

  1. Open the TM1 Cognos Applications portal.
  2. Click the Export Application icon under the Actions column.
  3. From the File Download dialog box, click Save.
  4. Navigate to the directory to where you want to save the export file.
  5. Click Save.
Backup home.jsp in folder D:\Program Files\ibm\cognos\tm1web\webapps\tm1web
Backup CommonMessages.js in folder D:\Program Files\ibm\cognos\tm1web\webapps\tm1web\scripts\tm1web\common\nls\sv
Backup Tm1WebAppCam.js in folder D:\Program Files\ibm\cognos\tm1web\webapps\tm1web\scripts\tm1web\standalone
Backup pa_header.svg file in D:\Program Files\ibm\cognos\tm1web\webapps\tm1web\scripts\tm1web\themes\carbon\standalone\images\login
If HTTPS is used, backup all certificate stores
Ensure that anti-virus or Windows Defender SmartScreen is turned off on the server during installation
Uninstall Planning Analytics Performance modeler from the windows server before you install the upgrade of TM1
Check that firewall ports between servers are open

Port 25, 80, 9300, 9362, 1433, 389 etc for BI. Port 5495, 5498, 5895, 5898, 8888,9510,9511,9012, 12345, 12346 , 12366 etc for PAL
Stop all related IBM Cognos TM1 and IBM Planning Analytics services and set to MANUAL
Reboot Microsoft Windows server
Install PAL from file tm1_winx64h_2.0.919.10_ml.tar (run as administrator)
Install TM1WEB from file tm1web-11.0.93-24020517-winx64h_bundle
Go into cognos configuration and click save
Reboot the Windows server
Modifications are required when FIPSOperationMode set to 1 (Basic)

— Remove or deprioritise TLS RSA CipherSuites

— TLS V1.2 or higher must be enabled

— EDCHE CipherSuites must also be enabled 

Restore configuration files that were backed up before
Start the IBM planning services  (start CA11 if needed)
Check that you can login to TM1 Architect
Check that you can login to TM1WEB
Set all related IBM Cognos TM1 and IBM Planning Analytics services to AUTOMATIC start
Reboot windows server
Check that you can run Cognos Analytics reports against the upgrade TM1 cubes


In older versions, this was also needed to be done:

Planning Analytics often uses Cognos Analytics for authentication. If CAM security is used and an SSL certificate has been enabled in Cognos, then we need to add the certificate from Cognos Analytics into Planning Analytics. This post explains the steps required to integrate Cognos Security with SSL for Planning Analytics LocalTM1Web (Planning Analytics Spreadsheet Services) and Planning Analytics Workspace.
Extract from above websites:
Navigate to the Planning Analytics server and to the directory < PA install location> \bin64\ssl and copy the ibmtm1.arm file to the Cognos Analytics server. You can copy the file anywhere, but I recommend creating a directory for it in the installation location.
In order to import this certificate we use an executable on the Cognos Analytics server called ikeyman.exe which resides in the <CA install location> \ibm-jre\jre\bin directory. Simply double click this file to open it.
Click the Open icon on the toolbar, ensure the Key Database type is set to JKS, navigate to the directory <CA Install Location> \ibm-jre\jre\lib\security, and open the file called cacerts.
Now you have loaded the certificate file it’s time to import the Planning Analytics certificate. Under the ‘key database content’ section change the drop-down value to ‘Signer Certificates’ and press the ‘Add’ button….



Planning Analytic Workspace upgrade Date
Copy the media to the server d:\install
Unzip the file
Check free disk space on the PAW windows server
Rename folder to PAW92 and place it at root
Exclude new folder d:\paw92 from anti-virus scanning
Copy the <paw_install_location>/config/paw.ps1 file from your current installation to the new installation location
Copy the <paw_install_location>/config/certs directory from your current installation to the new installation location.
If you configured SSL, copy the <paw_install_location>/config/ssl directory from your current installation to the new installation location.
Take screen capture of the configuration today in PAW administration – any existing errors will not be solved by upgrade.
Take a backup
Stop the docker containers Paw.ps1 stop
Check that no running dockers containers Docker ps
Go to the new folder
Run installation ./start.ps1 Start.ps1
Check that admin settings are correct
Check you can login to PAW website
Stop the docker containers Paw.ps1 stop
Reboot windows server, this to ensure the system will work after a reboot.
Check you can login after 30 min
Download the new kate agent
Unzip to a temp folder
To update the Planning Analytics Administration agent Windows service, run UpdatePAAAgent.bat, passing in the full path to <PA_install_location>, that is, the parent of the paa_agent directory.
Check that contain the settings for smtp email as before
Running the /clean.ps1 script removes images for the release in which it is run. Run from old folder e.g. d:\paw90
Check free disk space



More information: 

Due to a security update included in Planning Analytics, customers who have the non-default FIPSOperationMode=1 set in their Tm1s.cfg should remove or deprioritize the TLS RSA CipherSuites for a successful handshake to occur. This includes all CipherSuites that are prefixed with TLS_RSA_. This also means that TLS V1.2 or later must be enabled, as TLS 1.1 and prior do not support alternatives. In the case of TLS V1.2, the ECDHE CipherSuites must also be enabled.

Planning Analytics TM1 Perspective

Microsoft® Excel® for Microsoft 365 MSO (Version 2308 Build 16.0.16731.20542) 64-bit


After installing a new TM1 Perspective, you get a message when you start excel:

Microsoft Office has identified a potential security concern. The digital signature is valid, but the signature is from a publisher whom you have not yet chosen to trust.


Press “Trust all from Publisher” and TM1 perspective will work in your excel installation.


More information:



Microsoft SQL server 2019


How find what SQL Query is it that i is working one?


When you have a long list of Query’s you work with, click on the little PIN one each and they will stay at the top. And maybe it is easier for you to find back to the one you want to work with.


Other tip is to use WHERE 1=1 in your statements, to easy then remark the lines you need or not need when you adjust your selection.

SELECT TOP (1000) [GeographyKey]
FROM [AdventureRestore].[dbo].[DimGeography]
and CountryRegionCode = 'AU'
--and city = 'Alexandria'
and PostalCode = 2015


More Information:

Cognos Controller 10.4.2200.88
Microsoft Excel 64 bit Microsoft® Excel® for Microsoft 365 MSO (Version 2302 Build 16.0.16130.20684) 64-bit
Microsoft Windows 11


After upgrade to Excel 64 bit, Excel crash at start. The add in for Cognos controller can be for the 32 bit version of the Excel program.


Inside Excel, go to file – options.

Go to Add-ins dialog.

Manage‘ is set to ‘Excel Add-ins‘, and click ‘Go’.

Remove the mark for the first Cognos Controller line (adxloader.controller.excellink). Should look like this when it is correct.

Click OK.

Manage‘ is set to ‘COM Add-ins‘, and click ‘Go’.

The Cognos controller link should point to the 64 bit version of the dll, as above.

Click OK.

Recommendation, is to start Cognos Controller program first, and from inside Cognos Controller click on the icon for excel, to start Excel.

Be patient, Excel take a long time to start.

If you check Excel add-ins when Cognos controller is running it can look like this:


More Information:

Microsoft Windows


How rename many files in a folder by change the first letter to a other letter?


Go to the command prompt.

Go to the folder where the files are.

Enter below to change all files to start with the letter b

ren  *.* b*.*


More Information:


Planning Analytics
Microsoft Windows 2019 server

In a TI process check that the parameter is not empty?


If the parameter is pFirst then enter code like this in prolog:

IF ( ~( pFirst @= '' ) ) ;

    ProcessQuit ;

ProcessQuit will stop the process totally,  itemreject will go to the next tab and process that – if run from prolog. In MetaData and Data tab the itemreject will act different.

# sErrorMessage = ‘The ‘ | pFirst | ‘ is not empty’;
# ItemReject ( sErrorMessage );

More Information: 


Planning Analytics Workspace version 88


How add or change text to the front page?


Login to PAW and go to administration.

Click on customization.

Click on themes.

Select system default and click download at the right. should you save in a empty folder.

Unzip to a folder sample-theme.

Rename folder sample-theme to DEV-theme.

Go into folder, and open file spec.json in notepad++

Edit the text, to something like this

“name”: “DEV-theme”,

Change the path in “brandIcon”: “DEV-theme/images/brand.svg”, to be the same as your folder name.

Change any color values – like “appbarBackground”:”#66a3ff”,

Save the file.

In file manager, use 7zip, to zip the folder to a new file:

Go back to PAW Admin page in your browser.

Click on ADD, and upload you new theme.

Select the new theme, and click Active on the right.

The SVG files can be edit with inkscape 

More Information: 

JSON key name
name The name for the theme. This name is displayed on the Themes tab of the Excel and Customizations page in Planning Analytics Workspace Administration. You cannot use the name System default, which is reserved for the system default theme.
brandText The branding text to display on the Planning Analytics Workspace home page.
brandIcon The branding image to display on the Planning Analytics Workspace home page. This image is displayed immediately prior and near the brandText.
favicon Not currently supported.
uiShellTheme Determines the appearance of items in the Home menu Home menu. Specify either light (carbon 10) or dark(carbon 100) background.
appbarBackground Application bar background color. This color is applied to the entire application bar, both clickable and non-clickable regions.
appbarForeground Application bar foreground color. This color is applied to text and icons on the application bar.This setting is not applied to the Switcher widget on the application bar. The Switcher displays a list of open items. The text of the Switcher always appears White.
appbarSelectLine Application bar selection line color. This color is applied to the border that surrounds a selected or clicked item on the application bar.
appbarPushButtonBackground Application bar push-button background color. This color is displayed when you hover or click an item on the application bar.
navbarBackground Navigation bar background color. This color is applied to the entire navigation bar, both clickable and non-clickable regions.
navbarForeground Navigation bar foreground color. This color is applied to text and icons on the navigation bar.
navbarSelectLine Navigation bar selection line color. This color is applied to the bar that appears on a selected navigation bar item.
navbarPushButtonBackground Navigation bar push-button background color. This background color is displayed when you click on an item on the application bar.
personalMenuBackground Specifies the background color of the Personal menu icon User icon.Specify inherit to inherit the navbarBackground and navbarPushButtonBackground colors.

See Application of theme keys in Planning Analytics Workspace for a graphical depiction of the application of theme keys in the user interface. 

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

Microsoft Windows 2019 server

How do i give a message to Tm1Web users that they will always see?


Edit the CommonMessages.js file and the home.jsp files in Notepad++.

The first is the name of the tab in the web browser – here you can add text, like 1984 in our example by edit the file home.jsp in folder C:\Program Files\ibm\cognos\tm1web\webapps\tm1web. Change the row 47 to the text you want:

<title>IBM Cognos TM1 Web 1984</title>

Save the file and refresh your web browser to see the change.

The second value is in a different folder for each language. The language setting in your web browser will tell what text you will show.

Go to folder C:\Program Files\ibm\cognos\tm1web\webapps\tm1web\scripts\tm1web\common\nls\sv for Swedish language.

Edit the 378 or 379 row in file CommonMessages.js to your message text:

OFFERING_NAME:"Cognos® TM1® Web (please use chrome)",

Save the file and refresh the web browser. If you do not see the text, go into the settings and change the language for the web browser.

For English language, you may need to edit in the Tm1WebAppCam.js file, direct in folder C:\Program Files\ibm\cognos\tm1web\webapps\tm1web\scripts\tm1web\standalone. Search for the word cognos to find where you can edit the file.


Third, you may want that the users of TM1WEB should not see the cubes views at all. This is done by a change in the tm1web_config.xml file in folder

C:\Program Files\ibm\cognos\tm1web\webapps\tm1web\WEB-INF\configuration.  Edit the line 25 to this:

<add key="NavTreeDisplayServerView" value="N" />

Save the file and restart the service “IBM Planning Analytics Spreadsheet Services”.

To change the background picture in TM1WEB you may need to edit the file C:\Program Files\ibm\cognos\tm1web\webapps\tm1web\scripts\tm1web\themes\carbon\standalone\images\login\PA_Header.svg.

These changes is not supported by IBM.

More information: