Configuring Performance Modeller and TM1 Web with CAM Security for TM1 10.2.n

Today I have been working integrating TM1Web 10.2.2, BI 10.2.1 and Performance Modeller for a client. The documentation supplied by IBM doesn’t cover all the aspects to this and the technotes and information on the Web is out of date and relates mostly to very old versions of TM1 (9.5.n). Therefore, I have put the following article together to give you fewer headaches configuring TM1Web, Performance Modeller and securing it against Cognos CAM Security. My example has been worked on latest versions but should apply to all 10.2.n family of TM1 products.

Objective

To configure TM1 Web and Performance Modeller / Planning Service to use CAM Authentication and Single Signon.

Environment

We have two servers, server one (mybiserver) is a BI Gateway, Content Manager and Dispatcher and server two (mytm1server) is a TM1 Server with all TM1 components installed.

Configuring TM1 Web

By default the URL for TM1Web is http://mytm1server:9510/tm1web.

This works by default with the default installation, however, if your TM1 Server is configured to use CAM Security (IntegratedSecurityMode 5) rather than Native (IntegratedSecurityMode 1) then you will hit issues trying to access it.

To configure TM1Web to use CAM Secured Servers do the following:

 

STEP 1 – Create the variables_tm1.xml file

This file links BI to the TM1Web Interface using CAM Authentication. Simply make a copy of the file variables_tm1.xml.sample in the BI Server installation directory …\templates\ps\portal and call it variables_tm1.xml. Once in situ, edit the file to include your tm1server as the example below shows. The file contains a NETBIOS and FQDN value to ensure it works in all circumstances.

 

STEP 2 – Add CAMPortalVariableFile to tm1s.cfg

Next you need to add the reference to the variables_tm1.xml file into your TM1 Server and connect BI authentication if it is is not already in place.

Open your TM1 Servers tm1s.cfg file and add/amend the following lines to it.

IntegratedSecurityMode=5

ServerCAMURI=http://mybiserver:9300/p2pd/servlet/dispatch

ClientCAMURI=http://mybiserver/ibmcognos/cgi-bin/cognosisapi.dll

ClientPingCAMPassport=900

CAMPortalVariableFile=portal\variables_TM1.xml

Remember, if your BI Gateway is using CGI and not ISAPI then use cognos.cgi not cognosisapi.dll.

 

STEP 3 – Configuring TM1Web Main Page

The next step is to configure TM1Web and to avoid service errors when accessing TM1Web. To do this you edit the tm1web.html file in the BI Install Location\webcontent\tm1\web directory.

The following change need to be made:

On Line 41 – change the var tm1webServices variable to use references to your TM1 Server as below.

 

STEP 4 – Modify the TM1Web Configuration to choose Admin Server

To modify the TM1Web front page to automatically select an admin server and TM1 Server modify the file tm1web_config.xml in directory

TM1 install location\webapps\tm1web\WEB-INF\configuration.

Change the following arguments to select defaults:

<!– If set, users will not be asked to enter Admin Host during login. –>

<add key="AdminHostName" value="mytm1server" />

and optionally

<!– If set, users will not be asked to select a TM1 Server to connect to during login. –>

<add key="TM1ServerName" value="GO_New_Stores" />

When complete, save the file and restart the ‘TM1 Application Server’ windows service for the changes to take effect.

Testing TM1Web

To test TM1Web simply go to http://mytm1server:9510/tm1web and you should be prompted to select from a list of available TM1 Servers. Once you have selected the TM1 Server you will be prompted for appropriate Native or CAM Security before being presented with the TM1 Cube View screen.

TM1Web is now configured for both Native and CAM Secured TM1 Servers.

 

Steps to configure TM1 Performance Modeller

In order to configure Performance Modeller to function correctly with CAM secured TM1 Servers we need to perform some configuration work.

The steps required are as follows:

 

STEP 1 – Add required parameters to support Performance Modeller models.

These parameters and settings need to be added or modified in the TM1 Server tm1s.cfg file and the TM1 Server windows service restarted.

ServerCAMURI=http://mybiserver:9300/p2pd/servlet/dispatch

ClientCAMURI=http://mubiserver/ibmcognos/cgi-bin/cognosisapi.dll

ClientPingCAMPassport=900

CAMPortalVariableFile=portal\variables_TM1.xml

DistributedPlanningOutputDir=tunit

ForceReevaluationOfFeedersForFedCellsOnDataChange=T

AllowSeparateNandCRules=T

Some of the above will already have been added to the configuration file if you have previous configured TM1Web.

 

STEP 2 – Modify the Service Configuration file

Modify the fpm_svc.config file on the TM1 Server. The file resides in the TM1 installation location webapps\pmpsvc\WEB-INF\configuration directory. Stop the TM1 Application server service BEFORE editing this file.

The following arguments need to be completed / corrected:

By default, they will be pointing to localhost, you can also change these in Cognos Configuration IF you have NEVER configured TM1 Application Server to run with a Native secured TM1 Server. By checking this file and adding your Gateway and Dispatcher URI’s you will guarantee the correct settings are in place.

 

STEP 3 – Install and modify the BI Interoperability software

In TM1 releases prior to TM1 10.2 you had to use a separate install image to install the BI interoperability components. It is considerably easier now in that we have a single ZIP file called bi_interop.zip that resides in a bi_interop directory of the TM1 installation directory.

Copy this file and expand it into the BI installation directory. This places files in the following directories within the BI installation:

· Variables_plan.xml in \templates\ps\portal

· Planning.html in webcontent

· Pmhub.html in webcontent

· Icon_active_application.gif in webcontent\icd\feeds\images

· Icon_active_application.gif in webcontent\ps\portal\images

 

STEP 4 – Modify the BI Interoperability HTML Files

The two html files extracted into the Webcontent directory need to be modified as follows:

 

 

 

Testing Performance Modeller

Now the configuration is complete, restart the TM1 application server service to read all the new parameters and test access to the application through the URL http://mytm1server:9510/pmpsvc

If successful your browser will return a blank applications window as below.

 

Click the Open Performance Modeller button on the toolbar. This can take some time to open first time but will look for TM1 Servers that have the correct security and parameters. If more than one are found you will be prompted to choose and then Performance Modeller opens.

 

Good luck, I hope you get this working quicker than I did!!