Configuring Cognos Workspace / Business Insight to Connect to TM1

Resolving The Problem

How to Configure Cognos Workspace to Connect to TM1
Configuring Cognos Workspace to Connect to TM1 allows a BI/TM1 Customer to view TM1 Widgets in their Cognos Workspace dashboards. The TM1 Widgets essentially connect to TM1Web, allowing just a portion of the TM1Web applications to be ported over to the BI Dashboards.

Useful resources:
Configuring IBM Cognos Business Insight / Cognos Workspace to Use Content from a TM1 Data Server:
http://pic.dhe.ibm.com/infocenter/cbi/v10r1m1/index.jsp?topic=%2Fcom.ibm.swg.ba.cognos.inst_cr_winux.10.1.1.doc%2Fc_cnfgbux4tm1.html

Configuring the Web Host, Host Name, and Server Name for each TM1 Server:
http://pic.dhe.ibm.com/infocenter/cbi/v10r1m1/index.jsp?topic=%2Fcom.ibm.swg.ba.cognos.inst_cr_winux.10.1.1.doc%2Ft_buxtm1urlhstnm.html

Collecting Pre-Requisite Configuration Information:
You will want to make sure you/the customer has the following information prior to the Workspace Configuration:

1. Type of TM1 Security Mode (IntegratedSecurityMode parameter, in the tm1s.cfg file)
   IntegratedSecurityMode=1, (Basic TM1 Security)
   IntegratedSecurityMode=4 or IntegratedSecurityMode=5, (CAM Security)
   Any other security mode (2/3) is not supported
2. TM1WebHost (this is the host name of the TM1Web Server)
3. TM1WebVirtualDirectory (this is the alias for the TM1Web virtual directory in IIS)
4. TM1Host (this is the host of the TM1 Admin Server)
5. TM1DataServer (this is the name of the TM1Server instance you are connecting to)
6. If CAM Security is not used, you will also need a username/password for a TM1 Admin user
   

Steps to Configure Cognos Workspace:
To configure Cognos Workspace to connect to TM1, modifications must be made on all BI Application Servers. Prior to configuring Cognos Workspace to connect to TM1, you must ensure that your BI Dispatcher Servers are first able to connect to your TM1Web site directly. Additionally, the TM1Web server must be configured to allow for anonymous access.

Note: Common special character combinations and examples for the TM1Server name are:
Spaces – ‘Planning Sample’ must be referenced as ‘Planning%2520Sample’
Hyphens/Dashes – ‘Planning-Sample’ must be referenced as ‘Planning%252DSample’
Spaces and Hyphens/Dashes – ‘Planning - Sample’ must be referenced as ‘Planning%2520%252D%2520Sample’

%20 = space
%2D = hyphen
%25 = percent (%)

We need to do the %2520 to be able to pass a %20
We need to do the %252D to be able to pass a %2D



Configuring the ATOM file to Connect to a TM1 Server using IntegratedSecurityMode=1:

1. Navigate to your C10_InstallDir\configuration\icd\contributions\contrib\ directory
2. Copy and rename the tm1_contribution.atom.sample to tm1_contribution.atom
3. Edit the tm1_contribution.atom file with Notepad
4. Modify the following bolded values for the appropriate Rootfeed to match your environment:
   
   <atom:link rel="alternate" type="application/atom+xml" href="{cgi}/xts.run?m=tm1/serverContent.xts&amp;https=0&amp;TM1WebHost=TM1WebHostName&amp;TM1WebVirtualDirectory=tm1web&amp;TM1Host=TM1HostName&amp;TM1DataServer=TM1ServerHostWithoutCAM&amp;TM1username=admin&amp;TM1pass=apple" title="">
   
   For Example:
   <atom:link rel="alternate" type="application/atom+xml" href="{cgi}/xts.run?m=tm1/serverContent.xts&amp;https=0&amp;TM1WebHost=servername.fqdn.com&amp;TM1WebVirtualDirectory=tm1web&amp;TM1Host=servername.fqdn.com&amp;TM1DataServer=Planning%2520Sample&amp;TM1username=admin&amp;TM1pass=apple" title="">
   
   
5. Save the tm1_contribution.atom file
6. Copy the file to all BI Dispatcher servers
7. Restart all of the Cognos Dispatchers within the environment

Configuring the ATOM file to Connect to a TM1 Server using IntegratedSecurityMode=4 or 5:
Prior to configuring Cognos Workspace, if TM1 is configured to use CAM Security (IntegratedSecurityMode=4 or 5), your/the customer must confirm that the BI Server that TM1 is secured against, is the same BI Server that you are configuring Cognos Workspace for. To confirm, simple look at the following tm1s.cfg parameters:
ServerCAMURI=http://servername.fqdn.com:9300/p2pd/servlet/dispatch
ClientCAMURI=http://servername.fqdn.com:80/ibmcognos/cgi-bin/cognos.cgi

**Make sure that you are using Fully Qualified Domain Names (FQDN), everywhere. This includes the URL that the end user types into Internet Explorer. Not using a consistent URL will result in re-prompting to log in, as your BI CAM PASSPORT is associated to the domain (or lack of) when you first connect to Cognos BI.

1. Ensure the TM1 Interoperability package has been installed to all BI Servers, see http://pic.dhe.ibm.com/infocenter/ctm1/v10r1m0/index.jsp?topic=%2Fcom.ibm.swg.ba.cognos.tm1_inst.10.1.0.doc%2Ft_tm1_inst_installcognostm1andcognosbiinterop.html
2. On all BI Application Servers, make sure the C10_InstallDir\templates\ps\portal\variables_TM1.xml file, has the appropriate TM1Web server URL references defined.
   For example:
   <url is-regex="true">http:// servername.fqdn.com /TM1Web(/\([aAsS]\([A-Za-z0-9]+\)\))?/TM1WebLogin.aspx</url>
   <url is-regex="true">http:// servername.fqdn.com /TM1Web(/\([aAsS]\([A-Za-z0-9]+\)\))?/TM1WebLoginHandler.aspx</url>
   <url is-regex="true">http:// servername.fqdn.com /TM1Web(/\([aAsS]\([A-Za-z0-9]+\)\))?/TM1WebMain.aspx</url>
3. Navigate to your C10_InstallDir\configuration\icd\contributions\contrib\ directory
4. Copy and rename the tm1_contribution.atom.sample to tm1_contribution.atom
5. Edit the tm1_contribution.atom file with Notepad
6. Modify the following bolded values for the appropriate Rootfeed to match your environment:
   
   <atom:link rel="alternate" type="application/atom+xml" href="{cgi}/xts.run?m=tm1/serverContent.xts&amp;https=0&amp;TM1WebHost=TM1WebHostName&amp;TM1WebVirtualDirectory=tm1web&amp;TM1Host=TM1HostName&amp;TM1DataServer=CamAuthenticatedTM1ServerHost" title="">
   
   For Example:
   <atom:link rel="alternate" type="application/atom+xml" href="{cgi}/xts.run?m=tm1/serverContent.xts&amp;https=0&amp;TM1WebHost=servername.fqdn.com&amp;TM1WebVirtualDirectory=tm1web&amp;TM1Host=servername.fqdn.com&amp;TM1DataServer=Planning%2520Sample" title="">
   
   
7. Save the tm1_contribution.atom file
8. Copy the file to all BI Dispatcher servers
9. Restart all of the Cognos Dispatchers within the environment
   
   
   If you run into any problems, please see the 'Troubleshooting Cognos Workspace / Business Insight TM1 Connectivity' technote here: http://www-01.ibm.com/support/docview.wss?uid=swg21637834