Proven Practice

Integrating TM1 and IBM Cognos 8 BI

Product(s): TM1 9.4, IBM Cognos 8.4

Area of Interest: Integration

Integrating TM1 and IBM Cognos 8 BI 2

IBM Proprietary

Copyright and Trademarks

Licensed Materials - Property of IBM. © Copyright IBM Corp. 2009 IBM, the IBM logo, and Cognos are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at http://www.ibm.com/legal/copytrade.shtml

While every attempt has been made to ensure that the information in this document is accurate and complete, some typographical errors or technical inaccuracies may exist. IBM does not accept responsibility for any kind of loss resulting from the use of information contained in this document. The information contained in this document is subject to change without notice. This document is maintained by the Best Practices, Product and Technology team. You can send comments, suggestions, and additions to cscogpp@ca.ibm.com.

Integrating TM1 and IBM Cognos 8 BI 3

IBM Proprietary

Contents 1 INTRODUCTION............................................................................................ 4

1.1 PURPOSE ..............................................................................................................4 1.2 APPLICABILITY .......................................................................................................4 1.3 EXCLUSIONS AND EXCEPTIONS....................................................................................4

2 INTEGRATING COGNOS ACCESS MANAGER (CAM) SECURITY..................... 4

2.1 IMPORTING CAM OBJECTS INTO THE TM1 SERVER. ..........................................................6

3 CREATING AND IBM COGNOS 8 PACKAGE FOR REPORTING ....................... 9

4 ADDING THE PORTLETS.............................................................................. 20

4.1 USING THE PORTLETS ............................................................................................ 21

APPENDIX A – ADDING TM1 WEB TO THE PORTAL. .............................................. 28

Integrating TM1 and IBM Cognos 8 BI 4

1 Introduction

1.1 Purpose This document will discuss integration points between IBM Cognos 8 8.4 BI and IBM Cognos TM1 9.4. Security, Portlets and reporting techniques will be discussed.

1.2 Applicability Only TM1 9.4 and Cognos 8.4 can used for this integration. Security Integration takes place at the Server level therefore would need to be set for each TM1 Server.

1.3 Exclusions and Exceptions TM1 9.4 portlets can only be installed in 32bit mode. This reflects the ability of IBM Cognos 8.4 to host it’s gateway only in 32bit mode.

2 Integrating Cognos Access Manager (CAM) Security

TM1 can be defined to use CAM security. TM1 is able to use any security provider configured in IBM Cognos 8 Cognos configuration. These providers can range from Series 7, LDAP, Active Directory Services, and customer providers.

When adding IBM Cognos 8 security to TM1 native security must be disabled, and modification made to the tm1s.cfg file. Within the tm1s.cfg file the below entries must be made. The ClientCAMURI and ServerCAMURI must reflect the physical name or IP address of the IBM Cognos 8 BI Gateway and Primary dispatcher.

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 5

The CAMPortalVariableFile is only required when defining the TM1 portlets in IBM Cognos 8 portal. If the portlets will not be deployed this entry is not required. The ClientPingCAMPassport is used to determine the keep alive period for the authentication. This setting can be adjusted to suit the business needs. ClientCAMURI=http://localhost/cognos8/cgi-bin/cognos.cgi ServerCAMURI=http://localhost:9300/p2pd/servlet/dispatch CAMPortalVariableFile=portal\variables_TM1.xml ClientPingCAMPassport=900 Finally ensure the IntegratedSecurityMode=2 For example the tm1s.cfg file should now be similar to the screen capture below:

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 6

IBM Proprietary

Next open the tm1p.ini file located in the C:\Documents and Settings\<userid>\Application Data\Applix\TM1 Make the following changes to the tm1p.ini file. Setting the AllowImportCAMClients to T allows for administration and import of CAM clients in TM1. The CognosGatewayURI must point to a live Cognos Gateway. Save your changes.

AllowImportCAMClients = T CognosGatewayURI = http://localhost/cognos8/cgi-bin/cognos.cgi After all setting have been made to both the tm1s.cfg and tm1p.ini stop and start the TM1 Server.

2.1 Importing CAM objects into the TM1 server. Sign into the TM1 server as the native administrator. From Server Explorer click Security than Clients/Groups.

Integrating TM1 and IBM Cognos 8 BI 7

Once the Clients/Groups menu appears click the Clients menu and select Add New Clients. You will be prompted to sign into CAM. Enter a valid UserID and Password. Next the Cognos and 3rd party security provider namespaces appear. In this example only NTLM is used as a 3rd party provider.

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 8

It is possible to add users or groups from any available IBM Cognos 8 namespace displayed in this window. Clicking on the Namespace name will being traversing the provider where users or group can be added to TM1’s security entries. In order to show the user rather than group only check the Show users in the list checkbox. Navigate and check the box next to the users and group to be added. Once the entries are selected click the Green Arrow to add the users/groups to the selected entries box. In this example Moe and Daphne are added.

Click OK. The users from the NTLM namespace defined in IBM Cognos Configuration are now added. Ensure one of the new users is granted Admin access as TM1 native security will be disabled in the next set of steps.

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 9

Shut down the TM1 server, and reopen the tm1s.cfg file. Change the security mode to IntegratedSecurityMode=4 Restart your TM1 server, and log in. The logon prompt is now only directed to use the IBM Cognos 8 CAM security defined earlier.

3 Creating and IBM Cognos 8 Package for Reporting

IBM Cognos TM1 can be added for live reporting for you Plan, budget, or analysis. Open IBM Cognos 8 Framework Manager and click Create a new project…

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 10

Provide a name and location for the new project to reside.

If required authenticate against IBM Cognos 8, and select the necessary language. Once selected click OK. Selected Data Sources and click next.

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 11

Click the New… button and click next on the welcome page.

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 12

Provide a name and optionally a description of the connection, and click next. On the Specify the connection – New Data Source Wizard page click the drop down finding TM1. Click next.

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 13

Enter the location of the Administration Host and TM1 Server name. Select no authentication for the signon. Users will reuse their own signon credentials. Click finish.

Highlight the new datasource and click next.

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 14

Highlight the cube required for reporting and click next.

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 15

If there are any alias, or language requirements they must be selected for each dimension, else if the defaults are ok click next.

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 16

Leave the Create a default package box checked and click Finish.

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 17

The create a package wizard opens, provide a name for the package. This is the name visible on the IBM Cognos 8 portal. Optionally provide a description and screen tip. Click Finish. A message box appears asking to invoke the Publish Package wizard. Click Yes.

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 18

Leaving all the defaults selected click next, next and Publish. Once the Publish process has completed click the Finish button to exit the Publish package wizard. Close out of Framework Manager saving the changes. Open the IBM Cognos 8 portal browsing to http://servername/cognos8 and enter a User ID and password. The Package created in Framework Manager will now be present on the Portal home page.

Click on the package folder previously created, in this example plan_BudgetPlan and from the Launch menu select either Analysis Studio or Report Studio. Analysis Studio in selected this example.

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 19

Once the Insertable objects frame is displayed reporting can commence as with any other IBM Cognos 8 Package.

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 20

4 Adding the Portlets

In order to use the TM1 portlets in IBM Cognos 8 the change to the tm1s.cfg file made above must be in place. Within the TM1 install media the portlets are contained in a .tar.gz file. The name will change to reflect the version about to be installed. C8_TM1_Portlets_win32_8.4.28.4.tar.gz This compressed file must be installed on the IBM Cognos 8 gateway machine. In this example the portlets for TM1 9.4 MR1 are present. Using a compression utility such as winzip decompress the file keeping the directory structure. Open the directory structure and again decompress the C8_TM1_Portlets_win32_8.4.28.4.tar file. Within the newly decompressed directory structure two folders and an autorun.inf file will be present.

Opening the win32 directory and run the iissetup. The installation wizard will guide you through the installation of the porlets into the Cognos 8 environment. It is necessary to stop the IBM Cognos 8 service during this installation. Ensure when selecting the installation location it is the same location the active version of IBM Cognos 8 is installed. Once the install is complete the Transfer and summary-error logs location will be presented. Click finish and restart the IBM Cognos 8 service.

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 21

Once the Portlet installation is complete browse to the variables_TM1.xml file typically located in the <install>\program files\cognos\c8\templates\ps\portal directory. Add the URL’s for both the TM1webLoginHandler.aspx and the TM1webMain.aspx, as displayed in the screen capture below, and save your changes. The IBM Cognos 8 Service and the TM1 server must be restarted after this change.

4.1 Using the Portlets

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 22

Once the portlets install has been successfully completed the portlets must be configured for use within IBM Cognos connection. Open IBM Cognos Connection using Internet Explorer, and signin. Open Administer IBM Cognos Content then click the Configuration Tab, and select Portlets from the left pane. If installed correctly the IBM Cognos TM1 Viewers portlets should be present.

Click on the Home Button in the top right menu to return to the Home page of the IBM Cognos 8 Portal. We will now create a new page and define multiple TM1 cubes. Click the New Page button from the portal home page.

Enter a name, and optionally a description for the new page we will create. Provide a location for this page to reside, and click Next.

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 23

Define the number of columns required for your page, and how much of the page width they will consume. In this example there will be two columns, each sharing the page width at 50% each.

Click the Add… button below the frame on the left. Click IBM Cognos TM1 Viewers. Check the box next to the portlet required. In this example TM1 Cube Viewer is selected. Click the green arrow to move TM1 Cube Viewer to the selected entries box and click Ok. Repeat the same steps for the right frame. If desired a separate portlet entry can be chosen.

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 24

Each frame should now appear as below.

Click Next, if desired a title and instructions can be defined here, as well as setting the style of the Portlets page. For this example this will be skipped. Click Next.

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 25

The final page allows the options to insert the new page as tab on the Portal Home page and to will display the page immediately after clicking finish. Click Finish.

Click on the location selected to store the new page, and click to open the page.

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 26

Since there has been no default setting applied to the portlets cubes to be viewed must be defined at this point. One the left frame click on the Edit button in the top right. Enter the connection information for the TM1 server. Provide the server name and administration name. Once added click the select cube radio button and then the Select and entry… link. Select the Cube name, and the View name desired and click ok.

Scroll through the remainder of the properties page and define any required properties. In this example the display mode is Grid and Chart, the chart type is selected as Pie. Enter a title and select the Height in pixels. (This may require experimentation to determine the best height for the monitor size). Click OK.

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 27

Repeat the steps for the Frame on the right selecting a different cube and providing additional options as needed. Cube selection does not necessarily need to be from the same TM1 model. The page can display side by side cubes from any accessible model. Click ok and the IBM Cognos TM1 cube viewer portlet now displays both cubes side by side.

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 28

Appendix A – Adding TM1 Web to the Portal.

IBM Cognos TM1 Web can be integrated into the IBM Cognos 8 portal, users can then navigate the TM1 Web site as normal via a defined frame in the portal. To add TM1 web into the portal click to add a New Page button from the Portal Home page.

Enter a name, and optionally a description for the new page we will create. Provide a location for this page to reside, and click Next.

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 29

Leave the number of columns as one, and click the add button. In the portlets screen click Cognos Utility. Check the box next to HTML Viewer and click the green arrow to move it to the Selected Entries box.

Click OK to add it, and on the Set Columns and Layout wizard click Finish. The portal home page is displayed. Browse to the location the new page was stored, and click to open it.

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 30

In the top right click the edit button, enter a title, and the URL for TM1 Web. The Channel Name is not necessary at this time. Set the height in pixels, and click ok.

If prompted enter the Admin Host and TM1 Server information, and click Log In.

IBM Proprietary

Integrating TM1 and IBM Cognos 8 BI 31

IBM TM1 has now been defined and is accessible from the IBM Cognos 8 portal.

IBM Proprietary