How to setup TM1 Web and TM1 Applications for CAM authentication

Resolving The Problem

Part 1 - The TM1 Server CAM configuration.

To configure the TM1 Server for CAM authentication the following parameters must be set in the tm1s.cfg file.

IntergratedSecurityMode=5

ClientCAMURI=http://gateway.domain.com/ibmcognos/cgi-bin/cognos.cgi
ServerCAMURI=http://cognos.domain.com:9300/p2pd/servlet/dispatch

In the above example gateway.domain.com is the system running the Cognos BI Server gateway and cognos.domain.com is the system running the Cognos BI Server application tier (dispatcher). In an environment with multiple application tiers the tm1s.cfg file would be configure as follows.

IntergratedSecurityMode=5

ClientCAMURI=http://gateway.domain.com/ibmcognos/cgi-bin/cognos.cgi
ServerCAMURI=http://cognos1.domain.com:9300/p2pd/servlet/dispatch
ServerCAMURI=http://cognos2.domain.com:9300/p2pd/servlet/dispatch
ServerCAMURIRetryAttempts=3

Additional ServerCAMURI parameters can be added for additional dispatchers. The ServerCAMURIRetryAttempts is explained here:https://www.ibm.com/support/knowledgecenter/SS9RXT_10.2.2/com.ibm.swg.ba.cognos.tm1_inst.10.2.2.3.doc/c_servercamuriretryattempts.html

If Cognos Analytics 11.0.x is used instead of Cognos BI 10.2.x the ClientCAMURI should be set to http://cognos.domain.com:9300/bi/v1/disp if a separate gateway is not used. If an IIS gateway is configured for Cognos Analytics 11.0.x the ClientCAMURI should be set to http://gateway.domain.com:80/ibmcognos/bi/v1/disp.

If an IIS gateway with SSO is used with Cognos Analytics 11 please see: http://www-01.ibm.com/support/docview.wss?uid=swg22000283

Changes made to the IntergratedSecurityMode, ClientCAMURI, and ServerCAMURI parameters in the tm1s.cfg file require a restart of the TM1 Server in TM1 10.2.2. A restart is not required when changing these parameters as of Planning Analytics 2.0 Local.

Assuming the tm1s.cfg file is configured correctly, TM1 Architect and Perspective should be able to connect to the TM1 model with CAM authentication.

Part 2 - CAM configuration for TM1Web, pmpsvc, and pmhub

TM1 10.2.2 and Planning Analytics 2.0 Local include interoperability files that must be copied into the Cognos BI Server or Cognos Analytics 11 installation directories.

In Planning Analytics 2.0 Local the interoperability files for TM1Web, pmpsvc, and pmhub can be found in the ./tm1_64/bi_interop/bi_interop.zip file.

In TM1 10.2.2 the interoperability files for TM1Web is found in two zip files the ./tm1_64/webapps/tm1web/bi_files/ directory. The interoperability files for pmpsvc, and pmhub are found in the ./tm1_64/bi_interop/bi_interop.zip file.

The interoperability files for TM1Web, pmpsvc, and pmhub can also be downloaded from this Technote.

bi_interop.zip

Note that these files do not change between TM1 10.2.2 and Planning Analytics 2.0 Local.

All of the interoperability files should be unzipped to a common directory. The interoperability zip files should unzip into a separate webcontent and templates directory.

The templates directory must be merged with the templates directory for each application tier installation of the BI Server 10.2.x or Cognos Analytics 11.0 environment. A restart of the Cognos BI or Cognos Analytics service is required after updating files in the templates directory.

The webcontent directory must be merged with the webcontent directory for each gateway installation in the BI Server 10.2.x or Cognos Analytics 11.0 environment. If Cognos Analytics 11 is being used the contents of the webcontent directory should also be copied into the webcontent/bi directory for each gateway installation. A restart is not required after adding or updated files in the gateway installations.

The planning.html, pmhub.html, and tm1web.html must be updated to match the TM1 environment. Each of these files has a Javascript array that must be updated to include the URL used to access TM1Web, pmpsvc, or pmhub up to and including the port number used to access the web application.

tm1web.html - var tm1webServices = ["http://tm1web.domain.com:9510"];

planning.html - var planningServices = ["http://tm1web.domain.com:9510"];

pmhub.html - var pmhubURLs = ["http://tm1web.domain.com:9510"];

The URL in the Javascript array is the URL that would be entered into the web browser to access TM1Web, pmpsvc, or pmhub up to and including the port number. If a load balancer or proxy is used the load balancer or proxy URL must be used. For example:

tm1web.html - var tm1webServices = ["https://tm1web.domain.com:443"];

If multiple instances of TM1Web, pmpsvc, or pmhub use the Cognos BI/Analytics environment for CAM authentication them multiple entries can be added as follows.

tm1web.html - var tm1webServices = ["http://tm1webprod.domain.com:9510", "http://tm1webprod.domain.com:9510"];