There are a few important changes coming to installation and configuration process for the TM1 database in Planning Analytics Local!

Starting with the upcoming Planning Analytics Local 2.0.9.21 release the TM1 database installation program will switch from InstallStream to InstallAnywhere.  InstallAnywhere will be familiar if you have installed a recent version of Planning Analytics Spreadsheet Service.  InstallAnywhere is smaller and faster than previous install program.  This TM1 database installation file is less than 1 GB and takes less than 5 minutes to install.

In addition to the new installer program, we are also removing Cognos Configuration.  The TM1 Admin and TM1 databases can be registered as Windows services using the executables found in the bin64 directory.  This change reduces the complexity to deploy TM1 database services.  Cognos Configuration includes several open-source components that have previous required updates to address vulnerabilities.  Removing Cognos Configuration removes almost all open-source components that could be identified by vulnerability scanning tools.

In 2.0.9.20 and previous releases, Cognos Configuration was used to register, start, and stop services.  Here is a quick overview of the processes used to create the services in 2.0.9.21.  

 Registering the TM1 Admin service on Windows Server

<tm1_64>\bin64\tm1admsd.exe -install

Register a TM1 database service on Windows Server

<tm1_64>\bin64\tm1sd.exe -install -n <servicename> -z <path to tm1s.cfg>

For example:

<tm1_64>\bin64\tm1sd.exe -install -n 24Retail -z “C:\Program files\ibm\tm1_64\samples\tm1\24Retail”

The above example creates a Windows service named 24Retail with a display name ‘IBM TM1 Server x64 - 24Retail’.  The service name does not change with the 2.0.9.21 release.  The default service display name has been updated to remove the word Cognos.  The service display name can be changed to the previous default using the following command:

sc config 24Retail DisplayName=”IBM Cognos TM1 Server – 24Retail”

Make sure the command prompt or Powershell is opened with the 'Run as administrator' to register and make changes to Windows services.

The TM1 Admin and TM1 database services should now be started and stopped using the Windows Service list.  This can be accessed with the ‘services.msc’ command line.

Using the above scripts will create Windows services that follow the same naming convention as previous Planning Analytics Local releases.  This might be important if any existing automation is dependent on the service name.

Because Cognos Configuration no longer exists we are introducing a new configuration file for TM1 Admin.  The new config.tm1admsrv.json file can be found in the <tm1_64>\bin64 directory.  This configuration file contains the TM1 Admin configurations previous found in Cognos Configuration.  Note that changing the port numbers for the TM1 Admin server is not recommended.

Switching from the InstallStream to InstallAnywhere install programs does have a one-time cost.  It will be necessary to uninstall the previous release.  The new InstallAnywhere install program cannot update a previously version installed with InstallStream.  There are a few important things to consider when upgrading to a release that uses InstallAnywhere.

1.     1 - Other than sample databases the database files should not be stored in the TM1 installation directory.  If your TM1 database files are stored in the installation directory, then we recommend they be moved outside of the TM1 database install.  Uninstalling the previous release will remove any existing TM1 services on Windows.

2 - Any custom SSL certificates will need to be migrated to the new installation.  Before uninstalling the older release, we recommend looking at the tm1s.cfg files and the TM1 Admin server configuration in Cognos Configuration.  Both the tm1s.cfg file and Cognos Configuration may point to keystore and stash (kdb and sth) files that contain SSL certificates.  It’s also possible that custom SSL certificates were added to the default keystore file (ibmtm1.kdb) found in the bin64 directory.  In this case the ibmtm1.kdb and ibmtm1.stf file can be ported from the previous install directory.  Making a backup of the <tm1_64\>bin64\ssl directory from the previous TM1 database install is a good idea!

It is possible to use the InstallAnywhere installation to install 2.0.9.21 without first uninstalling the previous release.  This might be helpful if any configuration files need to be moved.  The new default path for the new installer is C:\Program files\ibm\tm1_64 (cognos was removed from the path).

What about TM1 Applications?

TM1 Applications (also known as TM1 Contributor) is the web tier component included with the TM1 databases installer in previous Planning Analytics Local releases.  If you don’t use TM1 Applications  you can skip this section.  Note that TM1 Applications is not required by any of the modern Planning Analytics components such Planning Analytics Workspace, Planning Analytics for Excel, or Planning Analytics Spreadsheet Service.  TM1 Applications is not part of the Planning Analytics 2.1 release.

If you are using TM1 Applications as part of the Planning Analytics 2.0.9 release, and the TM1 database and TM1 Applications were collocated, then you must install TM1 Application to its own directory.  TM1 Applications continues to use the older InstallStream program and Cognos Configuration in the 2.0.9.21 release.  It is still possible to install TM1 database and TM1 Applications on the same system, just in different directories.  Any custom configurations including SSL certificates need to be moved from the original install to the new install.

What about the TM1 Clients (Architect and Perspectives)?

A TM1 client installation program with Architect and Perspectives is still provided with IBM Planning Analytics 2.0.9.21.  Architect and Perspectives can be installed on the same system as the TM1 database but must be installed in a separate directory.  The separate TM1 Applications installation kit also continues to include Architect and TM1 Perspectives.

Planning Analytics Administration Agent

The Planning Analytics Administration (PAA) Agent is still included with the TM1 database installer in 2.0.9.21.  The installation includes the command line scripts that are required to register the PAA Agent service on Windows. 

To configure and register the PAA Agent service with Window run the following scripts in Windows Powershell or the command line prompt.

<tm1_64>\paa_agent\bin\PAAAgentSetJavaHome.bat

<tm1_64>\paa_agent\bin\PAAAgentRegister.bat

The IBM Planning Analytics Administration Agent service can be started and stopped from the Windows services list (services.msc).

It’s worth mentioning that the version of the IBM Planning Analytics Administration Agent should match Planning Analytics Workspace.  The process to update the IBM Planning Analytics Administration Agent from the Planning Analytics Workspace release can be found here: https://www.ibm.com/docs/en/planning-analytics/2.0.0?topic=components-planning-analytics-administration-agent-local-only

One last important detail to mention, these same changes can be found in the upcoming IBM Planning Analytics Local 2.1.8 release.  Planning Analytics on Cloud is not impacted by this change.  Additional details will be provided with the documentation for the upcoming 2.0.9.21 and 2.1.8 releases.