Configuring Cognos TM1 Applications to use Cognos Analytics Security

To configure IBM® Cognos® TM1® Applications to use IBM Cognos Analytics security, you work with files on the computers hosting these two components, plus the computer where the Cognos TM1 Server is running. This configuration also enables the IBM Cognos Connection portal to show links to Cognos TM1 Applications so that users can open the applications that they rights to from within the Cognos Connection portal.

Before you begin

The Cognos TM1 server must be configured to use Cognos Analytics security.

To use Cognos TM1 Applications with Cognos Analytics security, the IntegratedSecurityMode parameter in the Cognos TM1 Tm1s.cfg configuration file must be set to 5 to support user groups from both Cognos TM1 and Cognos Analytics.

For complete details and configuration steps, see Cognos security and Configuring the TM1 Server to use Cognos security.

Note: You must configure the TM1_PATH environment variable before you can connect to Cognos TM1 under a UNIX environment.

Procedure

  1. Extract the content of the bi_interop.zip file into your existing Cognos Analytics installation.
    Note: As of Cognos TM1 version 10.2.2, the bi_interop.zip replaces the planning_gateway.zip file that was provided with previous versions of Cognos TM1.
    1. Locate the bi_interop.zip file that is provided with the Cognos TM1 installation in the following location.

      Cognos TM1 location\bi_interop\

    2. Extract and merge the content of the bi_interop.zip file into the root directory of your existing Cognos Analytics installation.

      For example: C:\Program Files\IBM\cognos\ca_64\

      Note: The bi_interop.zip file contains a directory structure that merges files into the \templates and \webcontent subdirectories.
    3. To manually extract and copy the files to your Cognos Analytics installation, copy the files as follows:

      If you are using a distributed Cognos Analytics server environment, copy these files to the computer that is running the TM1 Data Tier or TM1 Web Tier as follows.

      planning.html
      Copy planning.html to CA Install Dir\webcontent and to CA Install Dir\webcontent\bi where the Cognos Analytics Gateway is installed.
      icon_active_application.gif
      Copy icon_active_application.gif to CA Install Dir\webcontent\ps\portal\images where the Cognos Analytics Gateway is installed.
      variables_plan.xml
      Copy variables_plan.xml to CA Install Dir\templates\ps\portal wherever the presentation service (Application tier) is running in a Cognos Analytics server.
      Note: These files are also installed with newer Cognos Analytics installations. If the files exist on your Cognos Analytics server, then you only need to edit them as explained in these steps.
  2. Edit the planning.html file.
    Important: The values for the planningServices parameter in this file are required to ensure that the Cognos Analytics server redirects users to only approved locations. The location of the Cognos TM1 Application Server from where the user logs in must be validated to be one of the approved locations in this file. Otherwise, the Cognos Analytics server will not redirect the user.
    1. Open the planning.html file and locate the following lines:

      // Update the following to point to the location of the planning service(s)

      var planningServices = ["http://machine.company.com:9510"];

    2. Set the planningServices parameter to the location and port number for the Cognos TM1 Application Server.

      var planningServices = ["http://web_server_address:port_number"];

      Replace web_server_address with the fully qualified domain name (FQDN) for the computer where the Cognos TM1 Application Server is running. For example, myhost.example.com

      • If you are running the Cognos TM1 Application Server with the WebSphere® Liberty server that is provided with the Cognos TM1 installation:

        var planningServices = ["http://web_server_address:9510"];

      • If you are running the Cognos TM1 Application Server with your own web application server, use the location and port number for that system.
      Tip: If you are using the same Cognos Analytics server to authenticate different instances of Cognos TM1 Applications that are running on multiple computers, use a comma-separated list with the fully qualified domain name (FQDN) for each computer. For example:

      var planningServices = ["http://machine1.example.com:port_number","http://machine2.example.com:port_number"];

      Tip: If the Cognos TM1 Application Server is running on a web server that belongs to multiple domains, use a comma-separated list to enter the fully qualified domain name for each domain. For example:

      var planningServices = ["http://computer_A.domain_1:port_number","http://computer_A.domain_2:port_number","http://computer_A.domain_3:port_number"];

    3. Save and close the planning.html file.
  3. Configure the session timeout parameters for Cognos TM1 Applications and Cognos Analytics security to ensure the proper timeout detection.

    For details, see Configuring session timeout values for Cognos TM1 Applications and Cognos Analytics Security.

  4. Restart the Cognos Analytics server.
  5. Configure Cognos TM1 Applications with values for the IBM Cognos Gateway URI and IBM Cognos Dispatcher URI .
    1. Open Cognos TM1 Applications using the format of the following link:

      http://web_server_name:port_number/pmpsvc

      For example: http://localhost:9510/pmpsvc

    2. Log in and open the Cognos TM1 Applications Configuration page:
      • If you are running Cognos TM1 Applications for the first time, the Configuration page opens after you log in.
      • If you already configured Cognos TM1 Applications, open the Configuration page by clicking the Administer IBM Cognos TM1 Applications icon Administer IBM Cognos TM1 Application icon on the toolbar of the TM1 Applications portal page.
    3. On the TM1 Applications Configuration page, enter values for the following Cognos TM1 and Cognos Analytics parameters:
      • Enter values in the TM1 Admin Host and Server Name fields and configure the options for the data contribution clients that you want to use. For details, see Configuring the server and client environment for TM1 Application Web.
      • Set the IBM Cognos Gateway URI parameter. For example:

        http://CognosServerName/ibmcognos/bi/v1/disp

      • Set the IBM Cognos Dispatcher URI parameter. For example:

        http://CognosServerName:9300/p2pd/servlet/dispatch

        Replace CognosServerName with the name of the system where the Cognos Analytics web server is running.

  6. To test the configuration, log in to Cognos TM1 Applications using a web browser on a remote computer.

    If you see the following error, review your settings for the planningServices parameter in the planning.html file on the Cognos Analytics server.

    The planning service parameter was not specified or is not 
one of the configured locations