Configuring Jazz user authentication on the Cognos Business Intelligence server

Once you have the Cognos® Business Intelligence server installed and configured, you can set up authentication with the Jazz™ Team Server.

Setting up Jazz Team Server to connect to the Cognos Business Intelligence server


  1. Open the Jazz Team Server administration page at https://[hostname]:[port number]/jts/admin.
  2. Click the Administration icon in the toolbar Admin icon and select Manage Users.
  3. In the Active Users list, click the user name that you want to use for the authentication, for example a test user.
  4. In the Repository Permissions section, ensure that the JazzAdmins check box is selected.
  5. In the Client Access Licenses section, select the Rational solution for Collaborative Lifecycle Management - Practitioner and Rational Team Concert - Developer check boxes.
  6. Save your changes.
  7. On the main toolbar, click Server to open the Server Administration page.
  8. In the Communication pane, click Consumers (Inbound).
  9. In the Consumer Name field, enter
  10. Enter your secret in both the Consumer Secret fields.
  11. Select the Trusted check box.
  12. Click Register. A consumer name called is added to the Authorized keys list at the bottom of the page.
  13. In the Configuration pane, click Advanced Properties and search for custom.In the Custom Reports section, ensure that the Custom Reporting Namespace is Jazz.
  14. Set the Reporting Server URL to http://[WAS profile server]:[port number]/p2pd/servlet/dispatch, where [WAS profile server] is the WebSphere® Application Server where the IBM® Cognos Business Intelligence application is deployed.
    Custom Reports properties

    If the report server is SSL enabled, enter https://[WAS profile server]:[port number]/p2pd/servlet/dispatch.

  15. In the Trusted URIs for client authorization and redirection field, enter http://[WAS profile server]:[port number]/p2pd.
  16. Click Save.
  17. Set the reporting server URL on the admin pages of the other applications. Open the administration page of each application at https://[host name]:[port number]/[application]/admin.

    For Requirements Management, use the rm application; for Change and Configuration Management, use the ccm application; and for Quality Manager, use the qm application.

    1. On the upper left of the Jazz Team Server Admin page, click Reports and then click Custom Reports Connection.
    2. Enter the Reporting Server URL as http://[WAS profile server]:[port number]/p2pd/servlet/dispatch.

      [WAS profile server] is the server name or the IP address of your server on which Cognos Business Intelligence is deployed; [port_number] is the HTTP port number assigned to the report server.

      If the report server is SSL enabled, enter https://[WAS profile server]:[port number]/p2pd/servlet/dispatch.

    3. Click Save.
    4. Repeat for the other applications.

Setting up Jazz authentication libraries in Cognos


On your file system, copy the contents of the ALM Cognos Connector lib folder , to the Cognos Business Intelligence and WebSphere Application Server profile folders.
  • Example ALM Cognos Connector lib folder : C:\Program Files\IBM\ALMCognosConnector\setup\rrdi\clm\cognos\webapps\p2pd\WEB-INF\lib
  • Example Cognos folder: C:\Program Files\IBM\cognos\c10_64\webapps\p2pd\WEB-INF\lib
  • Example WebSphere Application Server folder: C:\Program Files\IBM\WebSphere\AppServer\profiles\AppSrv01\installedApps\[node_cell]\IBM Cognos.ear\p2pd.war\WEB-INF\lib
The lib directory contains the following two plugins:
  • commons-codec-1.8.jar
  • commons-logging-1.1.2.jar
When copying over the content in the source lib directory to the target lib directory, the target library might contain the previous version of commons-codec.jar and commons-logging.jar. Delete the previous versions of these .jar files.

Configuring the Jazz namespace in Cognos


Open the jazzns_config.xml file located in the [ALM_Cognos_Connector_InstallDir]\setup\rrdi\clm\cognos\configuration folder. This file contains the information about CLM authentication (the consumer key and secret and the URLs for both the CLM server and the Cognos server) that the Cognos Business Intelligence server can use to connect to the CLM server. Verify that the information in this file is correct:
  1. Set the value of the jazz-namespace encrypted property to false.
  2. Ensure that the jazz-server url property is set to the Jazz Team Server URL.
  3. For the oauth-key property, copy and paste the consumer Oauth key from the entry that you entered in the Consumers (Inbound) section of the Jazz Team Server admin page.
  4. For the oauth-secret property, enter the same secret that you chose in step 10 of the Setting up Jazz Team Server to connect to the Cognos Business Intelligence server section.
  5. Make sure that the Jazz Team Server URL includes a fully qualified host name; for example, https://hostname:port/jts.
    Note: Ensure that the URL for the Jazz Team Server uses https and that your port number is a secure port.
  6. Make sure that the Cognos Business Intelligence URL includes a fully qualified host name; for example, http://hostname:port/reporting/servlet/dispatch.
    Note: Ensure that the URL for Cognos Business Intelligence uses http and that your port number is a public port.
  7. Save the changes to the jazzns_config.xml file. Here is an example of the jazzns_config.xml file.
    <?xml version='1.0' encoding='utf-8'?>
    <jazz-namespace encrypted="false"> 
            <jazz-server url="" oauth-key="yourkey" oauth-secret="yoursecret"/> 
            <report-server url=""/>

Setting up the Jazz authentication provider in Cognos


Copy all of the files in the [ALM_Cognos_Connector_InstallDir]\setup\rrdi\clm\cognos\configuration folder to the [CognosInstallDir]\c10_64\configuration, where [CognosInstallDir] might be D:\IBM\cognos.

Copying the icons and styles to the Cognos Business Intelligence application

About this task

Copy the report styles to the Cognos Business Intelligence application so that your custom reports will apply the same styles that they used in Rational® Reporting for Development Intelligence.


  1. Stop WebSphere Application Server.
  2. Go to the following directory [WAS_installdir]\WebSphere\AppServer\profiles\AppSrv02\installedApps\[node_cell]\IBM Cognos.ear\p2pd.war and delete all files and folders in this directory except for the WEB-INF directory.
  3. Copy the contents of the [Cognos_installdir]\c10_64\webcontent directory to the directory where the Cognos application is installed on WebSphere Application Server, for example [WAS_installdir]\WebSphere\AppServer\profiles\AppSrv02\installedApps\[node_cell]\IBM Cognos.ear\p2pd.war
  4. Start WebSphere Application Server.
  5. Copy the following files from ALM Cognos Connector:
    1. [ALM_Cognos_Connector_installdir]\ALMCognosConnector\setup\rrdi\cognos\webcontent\common
    2. [ALM_Cognos_Connector_installdir]\ALMCognosConnector\setup\rrdi\cognos\webcontent\reportstyles
    3. [ALM_Cognos_Connector_installdir]\ALMCognosConnector\setup\rrdi\cognos\webcontent\schemas
  6. Paste these files into the WebSphere Application Server profile directory where you have deployed the Cognos Business Intelligence web application, for example [WAS_installdir]\WebSphere\AppServer\profiles\AppSrv02\installedApps\[node_cell]\IBM Cognos.ear\p2pd.war. Overwrite the existing folders and files when prompted.

Creating a COGNOS_DIR environment variable on WebSphere Application Server


  1. Open the WebSphere Application Server administrative console and log in.
  2. In the administrative console, click Servers > Server Types > WebSphere application servers > server1
  3. In the Server Infrastructure group, expand Java and Process Management and click Process Definition .
  4. On the Process definition page, in the Additional Properties group, click Environment Entries.
  5. The COGNOS_DIR environment variable must have a value of [CognosInstallDir]\c10_64, for example, for example D:\IBM\cognos\c10_64. If this environment variable does not exist, create it.
  6. Add another environment variable called PATH listing the bin and bin64 directories, for example :
    Environment entries page of administrative console
  7. Save your changes to the master configuration.
  8. Stop and restart WebSphere Application Server.

Setting up the dispatch servlet for Cognos


Edit the web.xml files to use DispatchServlet instead of PogoServlet. The web.xml file must be changed in 3 locations:
  1. Cognos directory:, for example D:\IBM\cognos\c10_64\webapps\p2pd\WEB-INF\web.xml
  2. WebSphere Application Server profile directory:, for example D:\IBM\WebSphere\AppServer\profiles\AppSrv02\installedApps\[node_name]\IBM Cognos.ear\p2pd.war\WEB-INF\web.xml
  3. WebSphere Application Server cache directory:, for example D:\IBM\WebSphere\AppServer\profiles\AppSrv02\config\cells\[node_name]\applications\IBM Cognos.ear\deployments\IBM Cognos\p2pd.war\WEB-INF\web.xml
Search for PogoServlet in each file. Change the following entry:
<param-value> com.cognos.pogo.transport.PogoServlet </param-value>
You can also make the change in one web.xml file and copy the edited file to the other two locations.

Setting up a Jazz connection to Cognos Configuration


  1. Run the cogconfig command from the [CognosInstallDir]\c10_64\bin64 directory.
    • For Windowscogconfig.bat
    • For Linux./
  2. In the Explorer view of the Cognos Configuration window, select Local Configuration > Security > Authentication > Cognos.
  3. Set the Allow anonymous access property to false.
  4. Right-click the Authentication node and select New resource > Namespace.
  5. In the Name field, enter Jazz.
  6. In the Type field, select Custom Java Provider.
  7. In the Explorer view, select the new Jazz node and enter Jazz in the Namespace ID field and enter JazzNamespace in the Java class name field.
    Namespace defined in Cognos Configuration
  8. Click Save and close the Cognos Configuration window.
    Note: After valid authentication, the jazz_ns_config.xml file is encrypted. For example, the encrypted value is set to true and that the values for oauth-key and oauth-secret are encrypted.
  9. Stop and restart the Cognos Business Intelligence server.

Verifying the login


  1. Open a web browser and go to the Cognos Business Intelligence server URL, for example http://[Cognos_BI_server]:[port number]/p2pd/servlet/dispatch
  2. Verify that you are prompted to log in with your Jazz credentials:
    Log onto Cognos report server
    Note: If this login prompt does not appear, check the Cognos startup status in the cogserver.log file, for example C:\Program Files\IBM\cognos\c10_64\logs\cogserver.log.
  3. Enter your Jazz user id and password. The IBM Cognos Connection window opens.
    Cognos Connection home page

video icon Video channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community forums library

support icon Support

IBM Support Community
Deployment wiki