Configuring Planning Analytics Workspace to use Cognos security

Follow these steps to configure Planning Analytics Workspace to use IBM® Cognos® authentication security.

Before you begin

Note: If you applied a Cognos Analytics updater kit to your Analytics installation, you might need to make specific updates to the pmhub.html file.

The pmhub.html file supports IBM Cognos authentication security. However, it does not get updated when you apply a Cognos Analytics updater kit. Instead, an updated file that is called pmhub.html.new is placed in the same Cognos Analytics ...\webcontent directory as the original file. Use the newer version of pmhub.html and update it with any changes you made in the original pmhub.html file.

About this task

This configuration task requires downloading two files and copying them over to your Cognos Analytics system. The required files are available in the bi_interop.zip archive, which can be downloaded from Interoperability files required for TM1 Web to use Cognos security.
The following are the required files:
variables_plan.xml
After you extract the archive, this file is located in <extraction_directory>\templates\ps\portal.
pmhub.html
After you extract the archive, this file is located in <extraction_directory>\webcontent.

Procedure

  1. Download and extract bi_interop.zip.
  2. Copy and paste variables_plan.xml to <Cognos location>\templates\ps\portal on every server where the Planning Analytics Tier is running on your IBM Cognos Analytics system.
  3. Copy and paste pmhub.html to <Cognos location>\webcontent on every server where the Cognos Analytics Gateway is running on your IBM Cognos Analytics system.
  4. Edit each instance of the pmhub.html file to point to where Planning Analytics Workspace is running.

    var pmhubServices = ["http://SystemName:PortNumber"];

    For example:

    var pmhubServices = ["http://mysystem:9510"];

Configuring IntegratedSecurityMode=5 with Planning Analytics Workspace

IBM Planning Analytics Workspace delivers a web-based configuration tool.

About this task

IBM Planning Analytics Workspace delivers a web-based configuration tool. If the Cognos Analytics Gateway is configured for SSO, it is required to temporarily disable the SSO while you are configuring settings in the Admin Tool, otherwise the verification fails. You can disable SSO so by temporarily disabling the SSO Login and Legacy SSO Rewrite Rule in your web server.

Procedure

  1. Configure the IBM Planning Analytics Workspace Administration Tool.
    1. Open http://paw-host:8888 in a browser. If not done before, read and agree to the Terms of Service.
    2. Enter the values of the TM1 Admin host and TM1 Application host. As the Docker container might not be able to resolve the hostname or DNS entries, use the IP address instead.
    3. Switch the Authentication to CAM.
    4. Enter the Cognos URLs into the IBM Cognos BI Gateway URI and IBM Cognos BI Dispatcher URI fields.
      Screenshot of IBM Cognos BI Gateway URI and IBM Cognos BI Dispatcher URI
    5. For IBM Cognos BI Authentication Namespace ID, enter the namespace ID configured in Cognos Configuration of the Cognos Analytics environment.
      IBM Cognos BI Authentication Namespace ID
    6. Select Validate to verify the entries made.
      Workspace Cogsecurity Validate Configuration
    7. Select Update, and wait for the Planning Analytics Workspace Services to be restarted.
    8. If SSO was disabled on the web server, enable it again after the restart was successful.
  2. Allowlist Planning Analytics Workspace URL.
    1. Open <cognos analytics gateway>\webcontent\bi\pmhub.html in an editor.
    2. Search for "var pmhubURLs".
    3. Expand the list of URLs from ["http://mypmhubserver1:9510","http://mypmhubserver1.domain.com:9510","http://pa-host:9510"]; to var pmhubURLs= ["http://mypmhubserver1:9510","http://mypmhubserver1.domain.com:9510","http://pa-host:9510","http://paw-host:80"];
    4. If you are using Cognos Analytics without a Gateway, repeat in <cognos analytics gateway>\webcontent\bi\pmhub.html.
  3. Verify the login in Planning Analytics Workspace.
    1. In a browser, open http://paw-host.
    2. When the Cognos Analytics login Screen appears, enter username and password for the configured Namespace ID and Sign in.
    3. Logoff.

Configuring IntegratedSecurityMode=5 with Planning Analytics for Excel

Procedure

  1. Configure server URL in Planning Analytics for Excel.
    1. In Planning Analytics for Excel, select the Connect > New Connection menu.
    2. Enter the details for the Planning Analytics Workspace environment.
      Screenshot of the Planning Analytics Workspace environment details
    3. Test the connection.
  2. Test the Connection in Planning Analytics Workspace.
    1. Select Connect.
    2. Select Planning Analytics Workspace, and then select the configured TM1 Server.
      Screenshot of the Planning Analytics for excel
    3. When the Cognos Analytics login screen appears, enter username and password for the configured Namespace ID and Sign In..
    4. Open the Task Pane on the right and expand the TM1 Server.
    5. Logoff.