CogKnowHow

Product:

Planning Analytics 2.1.14
Microsoft Windows 2022 server

Issue:

How replace \ with / in a string in a TM1 TI process?

Solution:

Enter below code in you prolog:

vTemp = '';
vChar = '';
k=1;
WHILE( k <= LONG(pFilePath) );
  vChar = SUBST(pFilePath, k, 1);
  IF(vChar @= '\');
    vChar = '/';
  ENDIF;
  vTemp = vTemp | vChar;
  k = k + 1;

END;
NewFilePath = vTemp;

Content in pFilePath will be updated to NewFilePath variable.

More information:

WHILE Function: How to Use, Syntax, and Examples

https://cubewise.com/functions-library/tm1-function-for-ti-while/ 

Product:
Planning Analytics 2.1.14
Microsoft Windows 2022 Server

Issue:

How call RUSHTI.EXE from TI process when using SSO with IntegratedSecurityMode=5  (CAM)?

https://github.com/cubewise-code/rushti

Solution:

Run the TM1 service  (IBM TM1 Admin Server x64) and TM1 application service (IBM TM1 Server x64 – budget) with a windows account in your domain, that have rights inside your TM1 application (maybe ADMIN).  The ExecuteCommand is run with the user who runs the TM1 service.
Go to Windows service, and for your TM1 service, change the log on from Local System to account (a service account that does not change password) in the domain.

To call RUSHTI from a TI process enter something like this:

sCMD = 'd:\rushti\rushti run --tm1-instance "Budget" --workflow "load data fast" --max-workers 8 --mode opt' ;
ExecuteCommand(sCMD, 1);

https://github.com/cubewise-code/rushti/releases

To install RUSHTI.EXE you need to download the zip file, and unpack it to a folder on your server (d:\rushti)

Installation

1. Download rushti-windows.zip  (to start with, take this file https://github.com/cubewise-code/rushti/releases/download/v2.0.0/rushti-windows.zip )
2. Extract to your desired location (keeps directory structure intact)
3. Copy config/config.ini.template to config.ini and configure your TM1 connections
4. (Optional) Copy config/settings.ini.template to settings.ini for custom defaults
5. Run rushti.exe from command line

Note: This build uses PyInstaller’s onedir mode for fast cold starts.
Keep all files in the extracted directory together – the exe requires the bundled libraries.

You must have the files in the _internal folder, the files can not be replaced.

The config.ini contains the information to connect to your TM1 instance. Change for your environment, ports etc:

# The section name (e.g., [Budget]) is used as the instance identifier
# in task files and command-line arguments.
# For SSO set username to blank etc
# Copy this file to config.ini and update with your actual TM1 server details.
# the name of the tm1 application you should work with
[Budget]
# TM1 server hostname or IP address
address=tm1servername.domain.com
# REST API port (check your tm1s.cfg HTTPPortNumber setting)
port=12387
namespace=AD
gateway=http://caservername.domain.com:80/ibmcognos/bi/v1/disp
user=""
password=""
# Set to True if password is base64 encoded
decode_b64=False
# Set to True if TM1 server uses HTTPS (check UseSSL in tm1s.cfg)
ssl=True

Settings.ini is the file for defaults of the system to activate collection of data to database etc. It can look like this:

# RushTI Settings Configuration
# ==============================
#
# This file configures RushTI behavior settings, separate from TM1 connection
# settings in config.ini.
#
# Settings Precedence (highest to lowest):
# 1. CLI arguments (e.g., --max-workers 8)
# 2. JSON task file settings section
# 3. This settings.ini file
# 4. Built-in defaults
#
# To use this file:
# 1. Copy to settings.ini in the directory called config
# 2. Uncomment and modify the settings you need
# 3. Delete or leave commented any settings you want to use defaults for
# ------------------------------------------------------------------------------
# [defaults] - Common execution settings
# ------------------------------------------------------------------------------
[defaults]
# Maximum number of parallel workers
# Valid range: 1-100 (start with the same amount of CPU cores you have on the server)
# Default: 4
max_workers = 8

# Number of retries for failed process executions
# Valid range: 0-10
# Default: 0
# retries = 0

# Output file path for execution results summary CSV
# Set to a file path to create a summary CSV (e.g. rushti.csv)
# Leave empty or omit to skip creating the summary CSV
# Default: (empty - no CSV created)
result_file = rushti.csv

# Execution mode: 'norm' (normal) or 'opt' (optimized with dependencies)
# Default: norm
mode = opt

# ------------------------------------------------------------------------------
# [optimization] - Automatic task ordering optimization
# ------------------------------------------------------------------------------
[optimization]

# Enable automatic task optimization during execution.
# When enabled, ready tasks are sorted by estimated runtime (longest first)
# to maximize parallel efficiency. Dependencies are always preserved.
#
# Requires: [stats] enabled = true (needs historical data for estimates)
# Override: Use --no-optimize flag to disable for a specific run
#
# Default: false
# enabled = false

# ------------------------------------------------------------------------------
# [logging] - Enhanced logging settings / you must adjust this file to make it work
# ------------------------------------------------------------------------------
[logging]
# level = INFO
# file = /log/rushti.log

# ------------------------------------------------------------------------------
# [tm1_integration] - TM1 integration for reading taskfiles and logging results
# ------------------------------------------------------------------------------
[tm1_integration]

# Push execution results to TM1
# When enabled, the results CSV is uploaded to TM1 files after each run
# as: rushti_{workflow}_{run_id}.csv
#
# To set up TM1 integration:
# 1. Run: python rushti.py build --tm1-instance tm1srv01
# This creates the required dimensions and cube automatically.
# 2. Set push_results = true and configure default_tm1_instance below
#
# Default: false
push_results = true

# Automatically load results into TM1 cube after push
# When enabled (and push_results = true), calls }rushti.load.results TI process
# on the target TM1 instance after uploading the results CSV.
# The TI process must exist on the target instance.
#
# Default: false
# auto_load_results = false

# Default TM1 instance for reading taskfiles and writing results
# Used when --tm1-instance is specified without an instance, and for auto-upload
# Must be defined in config.ini, set the name for the section in config file.
default_tm1_instance = Budget

# Default cube name for task definitions and results
# The build command creates this cube with dimensions:
# - rushti_workflow: Workflow identifiers
# - rushti_task_id: Task sequence (1-5000 default elements)
# - rushti_run_id: "Input" for definitions, timestamps for results
# - rushti_measure: Task field measures
#
# Default: rushti
default_rushti_cube = rushti

# ------------------------------------------------------------------------------
# [stats] - SQLite stats database for execution history
# ------------------------------------------------------------------------------
[stats]

# Enable the stats database for storing execution history
# The stats database stores execution statistics for:
# - Optimization features (EWMA runtime estimation)
# - TM1 cube logging data source
# - Historical analysis via 'rushti db' commands
# Default: false
enabled = true

# Path to the SQLite database file
# Relative paths are resolved from the application directory
# Default: data/rushti_stats.db
db_path = data/rushti_stats.db

# Number of days to retain execution history
# Valid range: 1-365
# Default: 90
retention_days = 90

To create the RUSHTI cube, you run the command:

rushti build --tm1-instance "Budget"

If not using a CUBE for the tasks, you can use a TXT file. See link.
https://code.cubewise.com/open-source/tm1py/rushti/

To create an HTML file of the run information, enter command like below in the DOS prompt:

rushti tasks visualize  --tm1-instance "Budget"  --workflow "load data fast"  --output dag.html

Open the dag.htlm file in your web browser (with javascript enabled).

In the RUSHTI cube, you can use the predecessors column to tell what process should be finish before this process start. In below example the process number 3 starts first when process 2 is finished.

in process filed, enter the name of the TI process to run.

In parameters field, when you have more parameters than one , they can be formatted like this:

{ "pVersion": "Prognos 1", "pYear": "2025" , "pMonth": "03" }

There is a colon (:) between the prompt and the value, and a comma (,) between the parameters, or the simpler format shown below will work (you need the space before ,):

pVersion=Budget , pYear=2026 , pMonth=01

If you have a path in your parameter, then you need to enter / (forward slash) instead of \. So it should look like this:

{ "pNewCube": "thecubename", "pFilePath": "D:/Tm1 Data/budget/Export/to_other/read/Budget_2026_01.csv" }

You need to create a element in dim Rushti_workflow for your tasks settings, this i called from the rush command. For it to know what task list it should execute on, in the cube. e.g. –workflow “load data fast”

More Information:

https://www.ibm.com/docs/en/planning-analytics/2.0.0?topic=pctf-executecommand

https://code.cubewise.com/blog/introducing-the-tm1py-universe/

Full documentation is available at cubewise-code.github.io/rushti/docs

• Installation
• Quick Start
• Task Files
• CLI Reference
• Settings Reference

https://code.cubewise.com/downloads/

https://code.cubewise.com/blog/run-processes-in-parallel-using-only-connection/

Product:
Mirantis Docker
Microsoft Windows 2022 server

Issue:

How update the lic file on the docker installation on a Windows server?

Solution:

Buy a new license (Mirantis Container Runtime with LabCare Support) from Mirantis, one per PAW server. You will get a mail with a link, that will download the MCR file direct to your computer.

Then rename the file from like MCR 3xNode LabCare.lic  to docker.lic.

Copy the docker.lic file to your docker folder – normally that is D:\docker on your Planning Analytics Workspace (PAW) server.

To check that you have a license, enter below in CMD:

docker info --format '{{.ProductLicense}}'

You should get a text like this ‘Valid until 2026-04-09 for sf0643587264358638568230756MAC’ if all is fine.

More Information:

https://docs.mirantis.com/mcr/25.0/single/index.html#install-the-license

You can update the license in your cluster at any time during the week before your license expire.

As per our terms of service – “Users are not authorized to run MCR without a valid license.”, but even if you do not replace the license after the 10th, the docker service will not be forcefully stopped and there won’t be any interruptions to your applications and workloads.

You download Mirantis license (.lic) files from the Mirantis CloudCare Portal (or from a purchase confirmation email, depending on the product):

For MKE / MSR / MKE 4k:

1. Find the email from Mirantis Support with subject similar to “Welcome to Mirantis’ CloudCare Portal” and log in as instructed. [MKE 3.7 license; MSR 2.9 license]
2. In the top navigation bar, click Environments.
3. Click the Cloud Name associated with the license you need.
4. Scroll down to License Information and click the License File URL.
5. In the new tab, click View file to download the .lic file. [MKE 3.8 license; MSR 2.9 single]

For MCR (Mirantis Container Runtime):

• If you bought via the Mirantis Store, the license file is available from the link in your purchase confirmation email. Otherwise, you must contact Mirantis Sales/Support to get the file. [MCR 25.0 license]  

For Mirantis Container Runtime (MCR) / Mirantis Docker Engine, the license file must be placed in the daemon data directory and named docker.lic.

On Windows (default path):

• Copy the file to: %PROGRAMDATA%\docker\docker.lic [MCR install license]

Install MKE offline – Mirantis Kubernetes Engine

Index of win/static/stable/x86_64

By default, MCR automatically records and transmits data to Mirantis for monitoring and analysis purposes. The data collected provides the Mirantis Customer Success Organization with information that helps us to better understand the operational use of MCR by our customers. It also provides key feedback in the form of product usage statistics, which enable our product teams to enhance Mirantis products and services.

When antivirus and antimalware software products scan files in use by MCR, these files can lock in a way that causes Docker commands to hang or causes orphaned snapshots to leak disk space. To circumvent these problems, you can add the Docker data directory to the software’s exclusion list, which is by default /var/lib/docker on Linux systems and %ProgramData%\docker on Windows Server systems. As a result of this action, though, viruses or malware in local Docker images, writable layers of containers, or volumes will go undetected.

Product:
Planning Analytics Workspace 2.1.14
Microsoft Windows 2022 server

Issue:

How do i easy copy one book in PAW to other TM1 instance?

Solution:

Copy the JSON code between the TM1 applications.

Go to the book, click on the Swedish keyboard CTRL+Q+’     (That is the * key left of the carriage-return key.)

This opens up the JSON code that describe the book. This can be copied to notepad for editing, or direct to other PAW book.

More Information:

https://www.acgi.com/blog/copying-tabs-across-books-in-ibm-planning-analytics-workspace

https://community.ibm.com/community/user/blogs/george-tonkin/2023/02/18/copying-a-tab-from-one-paw-book-to-another

https://www.ibm.com/docs/da/planning-analytics/2.0.0?topic=books-create-book