r4 - 2014-05-20 - 15:10:58 - DeniseMcKinnonYou are here: TWiki >  Deployment Web > DeploymentInstallingUpgradingAndMigrating > InstallConfigureandDeployRRDIearFileonWASinFederatedEnvironment

uc.pngInstalling, configuring and deploying the RRDI p2pd.ear file on WAS in a federated environment

Authors: PhilippeChevalier
Build basis: Products, editions, or versions that apply to the content. If no build basis applies to this content, set the build basis to None.

#Introductory paragraph

Configuring the report server

During installation you opted to manually install the report server, configure the WebSphere Application Server instance to host the report server, and build, deploy, and install the enterprise archive (EAR) files.

Here is a high-level list of the configuration tasks

  1. Create and configure a new WebSphere Application Server profile to host the report server on a federated instance.
  2. Setup the Jazz Name Space
  3. Configure the RationalReport profile to host the report server.
  4. Build the report server enterprise archive (EAR) file.
  5. Install the report server enterprise archive (EAR) file.

Create and configure a new WebSphere Application Server federated profile and the report server

The following will describe the creation of a WebSphere node on a Deployment manager instance. Create and configure the server profile for support of the IBM Cognos EAR file.

In this section you will find three topics:

  • Creating the new federated node to host the Reporting server's Application
  • Creating the server instance to support the IBM Cognos EAR file
  • Configure the RationalReport profile to host the report server

Creating the new federated node to host the Reporting Server's application

  1. Navigate to the $WAS_INSTALL/bin/!ProfileManagement directory.

The WAS_HOME by default is usually /opt/IBM/!WebSphere/!AppServer. In the case of this document the value will reflect the WebSphere application server version number used /opt/IBM/!WebSphere/!AppServer855

  1. Start the Profile Management tool using the following command:


This pmt.sh tool will open a GUI interface to create WebSphere profiles.



To create Profiles, use the “Create” button on the right side of the window. You will be sent to the next panel called 'Environment Selection'.


As shown in the figure above, Use the option 'Custom profile', and click 'Next' at the bottom of the window.

The next panel will be the 'Profile Creation Options'.


You will be selecting the profile type, To create a managed node select the 'Advance profile creation' option, and then select next.

This will lead you to the 'Profile Name and Location' panel.


Replace the 'Profile name' and 'Profile directory' fields with the name for the profiles and its location. In this case we will use RationalReport for the profile name and update the profile location to target the $WAS_HOME/profiles/!RationalReport (see the above figure). Click on the 'Next' button at the bottom of the window.

The following panel will be called 'Node and Host Name'. On this panel you will be assigning the node name and the host name for the profile you will be creating.


In this panel we selected to call the node myserver2Node2 and the host name was myserver2.ibm.com. The Node reference *Node2 because on the machine used for this example *Node1 was already used.

Click Next to move to the next panel called 'Federated'. You will need a few details to setup the federated environment

  • The host name of the Deployment Manager (Dmgr)
  • The SOAP port for the Dmgr
  • The WebSphere administrator user name and password

Caution: the Dmgr service must be up and running already, make sure that it is.


In this case the host name was myserver.ibm.com, the SOAP port was 8879 (default) and the user name was wasadmin.

Note: To collect the SOAP port of the Dmgr, log in to the Dmgr console and navigate to the 'System administration → Deployment manager' using the right side panel of the console, select the link. On the Left you will find a link called 'Ports' with a + sign beside it. Select the + sign and this will reveal the ports assigned to the Dmgr.


You may see a check box to 'federate the node later' make sure it is unchecked.

Click on the Next Button.

The new panel will be Security Certificate (Part 1),


Leave the default values and click on the Next Button

The new panel will be Security Certificate (Part 2)


Like the previous Panel leave the default values. The Default keystore password is WebAS.

Click on the 'Next' button.

The Panel will now be called 'Port Value Assignment'. Generally the profile creation will target ports that have not already been assigned on the server. Review the values to find any port conflicts.


Click the Next button.

The last panel will be called 'Profile Creation Summary'. You will find a short summary of the details you selected for the profile creation.


To Complete the task, click on the 'Create' button. You will see a new panel called 'Profile Creation Progress' which will report back the progress of the setup task.


The last panel is the 'Profile Creation Complete' panel,


Select the Finish button and close the Profile Management Window.

To validate that the new profile, or in this case the server node was added to the Dmgr. Log in to the Dmgr console, and on the left Panel of the Console navigate to the 'System administration --> Nodes'. On the Right Panel you will see the new registered node.


It is possible that you find that the status of the node Is not consistent with the other nodes. If this is the case, select the check box beside the myserver2Node2, and click on the Synchronize button at the top of the table view.


The status will become consistent with the other nodes.

It is also possible to review the node up status in the 'System administration --> Node Agents'


  • Creating the server instance to support the IBM Cognos EAR file

You may expect since the server Node was added to the Dmgr, the RationalReport server be already in place. To verify, navigate to the '!WebSphere application servers' link on the left panel of the Dmgr console.


As you see the image above, the RationalReport server was not added. Running the Profile management tool with the option selected in the process above only created a WebSphere node to support new server instances on the myserver2Node2.

It is now time to create the RationalReportServer. Click on the 'New...' button at the top of the table view. The view will change to a panel called 'Create a new application server'. Using the 'Select node' field select the arrow on the right and click on the newly created node 'myserver2node2' and provide a name for the new server. In this case we will use '!RationalReportServer'


Click on the 'Next' button.

This will lead you to a new panel. Select the template for the Application server you are creating.


Use the template 'default', and click on the 'Next' button.

The new panel will be port selection.


To simplify the process this example will use the 'Generate Unique Port' option, and click next.

The last panel is a summary panel.


Review details and click on 'Finish'.

This will return you back to the 'Application servers' table. You will also have an extra message panel at the top of the panel. This is message will be a reminder to save the master configuration. You should also see the new '!RationalReportServer' instance


Click the 'save' link to save the master configuration.

Note: WebSphere application server configuration very often required the master configuration save action. It is recommended that you select the save link as often as possible to avoid losing any configuration points. This document will not repeat this action item, please keep it in mind.

After the master configuration has been saved, return to the '!WebSphere application server' link on the left panel. The newly created server status will be marked as down. We now need to test the server by starting the application and reviewing the SystemOut.log.

To start the server, select the check box beside the RationalReportServer and click on the start button at the top of the table view.


If the start process should be completed with a green arrow in the status column.

To double check the status of this new server you should review the SystemOut.log file. This files will be located in the WAS_HOME/profiles/$PROFILE_NAME/logs/$SERVER_NAME

Example: /opt/IBM/!WebSphere/!AppServer855/profiles/!RationalReport/logs


Generally if you do not see any Java Exception and you see the message “Server RationalReportServer open for Business”.



At this point you have successfully created the WebSphere application node and server instances.

Configure the RationalReport profile to host the report server

Using the Dmgr Console, verify that the RationalReportServer is up and running. Using the left panel of the console navigate to the '!WebSphere application servers' and select the link.


Click the RationalReportServer link and, in the Server Infrastructure section, expand the Java and Process Management node, continue and select the Process Definition link, and click the Java Virtual Machine link.


The bread crumb links should be Application servers > RationalReportServer > Process definition > Java Virtual Machine.

In the configuration tab, Enter inital and maximum JVM heap size. In the field 'Initial heap size' set the value to 256 and the 'Maximum heap size' set the value to 1024.


Click the 'Apply' Button at the bottom of the page. Your page should be back to Application servers > RationalReportServer > Process definition

On the top right side of the page, select the 'Environment Entries' link


In this configuration panel you will be entering three environment variable.


  • PATH=[INSTALLDIR]/cognos/bin:[WebSphere_Install_dir]/java/jre/bin/classic:[WebSphere_Install_dir]/java/jre/bin

  • LD_LIBRARY_PATH=[WebSphere_Install_dir]/java/jre/bin:[INSTALLDIR]/etl/odbc/lib:/usr/local/lib:[INSTALLDIR]/cognos/bin:[DB2_Install_dir]/lib32


Click Apply, and click Save.

If you are using administrative security, expand the Security node on the left sidebar and then disable administrative security by clearing the Enable application security option. Click Apply, and click Save.

Restart the RationalReport profile. by stopping and starting the report server.


Setup the Jazz Name Space, create the jazzns_config.xml file

This task is divided into two sections:

  1. Create the JTS Comsumer key
  2. Modify the RRDI Jazz names space configuration file, jazzns-config.xml

Steps to Create the JTS consumer key

Open the Jazz administration page at https://$HOSTNAME:$PORT/jts/admin.

Example: https://myserver.ibm.com:9443/jts/admin

Enter the user ID and the password. The user ID must be a member is the JazzAdmins group.

Navigate to the Admin page, click Server (at the upper left).


In the left Panel, select 'Consumer (Inbound)' link.

You should land on the 'OAuth Consumer' page.


In the Consumer Key field, do not enter anything. The key is automatically generated after you provide the necessary information.

Specify the consumer name to be com.ibm.rational.reporting.

Specify a consumer secret and enter it again in the second box.

Select Trusted.


Click Register. The Consumer Key is generated automatically.


Once the Consumer entry in created, navigate the new key and select the pencil in the actions column.

A new window titled 'Edit Consumer Key Properties' will appear, find the 'Select user …' link on the page and select the link. Search and assigned a user from JazzAdmins group. It is suggested to use a functional user. In this example, wasdmin will be used.


Once the selection has been made, click on the 'Add and close' button. You will be back on the 'Edit Consumer Key Properties', find the click the button 'Finish'.

The new record should be visible in the 'Consumer Name' list with the Functional user assigned to it.


Key this information handy, since it will be required for the RRDI Jazz name space configuration file jazzns-config.xml

Steps to Modify the RRDI Jazz names space configuration file, jazzns-config.xml

The jazzns_config.xml file defines the location and the authentication requirements for Jazz name spaces and identifies the RRDI server's URL. It is important to understand what are the Jazz OAuth requirements and the host name and port the jazz Team Server and RRDI server will be using before setting up this files.

To modify the jazzns-confgi.xml file, the application server supporting the Cognos applications must be down if the EAR file has been previously deployed.

Find and navigate to the jazzns-config.xml template file location. You locate this file in the following directory $RRDI_HOME/setup/rrdi/clm/cognos/configuration

Example: /opt/IBM/RRDI206/setup/rrdi/clm/cognos/configuration

Copy the jazzns_config.xml file to the $RRDI_HOME/cognos/configuration directory, using command cp jazzns_config.xml $RRDI_HOME/cognos/configuration move the terminal session work directory to $RRDI_HOME/cognos/configuration.


#> cp jazzns_config.xml /opt/IBM/RRDI206/cognos/configuration

#> cd /opt/IBM/RRDI206/cognos/configuration

The content of the file should expose 4 token that the setup tool uses to Identify the fields that requires modification. Each of these values are associated to the OAuth Consumer key of the Jazz Team Server or the report server URL.

1.[TOKEN_JAZZ_SERVER_URL] = Is the location of the Jazz Team Server targeted for the use of authentication. Format of the string “http://$SERVER:$PORT/jts

Example: https://myserver.ibm.com:9443/jts

Note: Port is optional, depending if your using the one of default HTTP(S) Ports 80 or (443). Make sure that the Jazz Team Server URL includes a fully qualified host name

2.[TOKEN_OAUTH_KEY] = Is the value of the consumer key we defined in the Jazz administration page 'OAuth Consumers'. From the 'Authorized Keys' table use the key in the 'Consumer Key' defined for the 'Consumer Name' com.ibm.rational.reporting we just created in section 'Steps to Creating the JTS consumer key'

3.[TOKEN_OAUTH_SECRET] = Used the secret used when the we defined the consumer key com.ibm.rational.reporting

4.[TOKEN_REPORT_SERVER] = Use the URL for the reporting server. Format of the string http://$SERVER:$PORT/reporting/servlet/dispatch

Example: http://myserver2.ibm.com:9085/reporting/servlet/dispatch

Note: Port is optional depending if your using the one of default HTTP(S) Ports 80 or (443). Make sure that the report server URL includes a fully qualified host name

The following is an example of the jazzns_config.xml template.

<jazz-namespace encrypted="false"> <jazz-server url="[TOKEN_JAZZ_SERVER_URL]" oauth-key="[TOKEN_OAUTH_KEY]" oauth-secret="[TOKEN_OAUTH_SECRET]"/> <report-server url="[TOKEN_REPORT_SERVER]"/> </jazz-namespace>

Using the text editor of your choice open the jazzns_config.xml file, and modify the token with the values required.

Make sure that the values of OAuth key and Oauth secret are the same as the values specified for the consumer name and password entries on the Jazz Team Server.

Set the value of the jazz-namespace 'encrypted' property to false.

Note: The OAuth key values are stored is in plain text when you save the jazzns_config.xml file. The string will be automatically encrypted when the report server starts and the 'encrypted' attribute will be reset to true.

Add an attribute to the jazz-namespace tag setEmailAsUserName="true"

Example Modify:

<jazz-namespace encrypted="false">


<jazz-namespace encrypted="false" setEmailAsUserName="true">

Note: The setEmailAsUserName is used to set the display name on the reporting server's, if the value is set to false the JTS repository User ID will be used. Under some circumstance, particularly with the Insight product using the UID can lead to duplication of User information. Generally and email address is a unique Identifier and is recommended.

Example results:

<jazz-namespace encrypted="false" setEmailAsUserName="true"> <jazz-server url="https://myserver.ibm.com:9443/jts" oauth-key="83d37bfe91934da3ab42bbacf0ddda10" oauth-secret="secret"/> <report-server url="http://myserver2.ibm.com:9085/reporting/servlet/dispatch"/> </jazz-namespace>

Save the changes to the jazzns_config.xml file.

Setup the IBM® Cognos® Configuration tool

Usually all of the environment and properties are setup by the RRDI setup server on standard deployment method. This section will provide the details of these manual updates. It will also layout out the configuration in two basic task, and provide more details of the database configuration for vendor other then DB2.

1.Modify the conconfig.sh file to support the WebSphere JRE and update the LD_LIBRARY_PATH environment variable

2.Start the IBM® Cognos® Configuration tool, and configure the Cognos environment

3.More about the Content Data Store Configuration, Other database software

To complete the task in theese section you will have to have access to a Linux desktop, or have access to a X Session terminal to allow the cogconfig.sh script to operate a Java window. It will also be important to have a text editor you are familiar with. The examples that will follow where all be executed with a VI editor. Be familiar with the editor your chose since this document does not provide information about the operations of the VI editor.

Note: The following section modifies manually the cogconfig.sh file. Backing up of the file is recommended.

Modify the conconfig.sh file to support the WebSphere JRE and update the LD_LIBRARY_PATH environment variable

Two edits of the $RRDI_HOME/cognos/bin64/cogconfig.sh file is required. The JAVA_HOME variable will be added using the WebSphere JRE and modification of the LD_LIBRARY_PATH will be required. Choose the Editor of you choice, the following examples will use the vi editor.

Example of Path: /opt/IBM/RRDI206/cognos/bin64/cogconfig.sh

The first Edit The JAVA_HOME variable, navigate to the $RRDI_HOME/cognos/bin64. Right after the initial comment section of the cogconfig.sh add the command “export $WAS_HOME/java/jre”.

Example: export JAVA_HOME=/opt/IBM/WebSphere/AppServer855/java/jre





The second change will be to modify the LD_LIBRARY_PATH by adding the /usr/lib directory to the path in the variables.

The following example uses the vi editor command:


This command will add the /usr/lib right after the equal sign of each LD_LIBRARY_PATH variable defined in the file.

From #FIGURE 41

Using Command




Save the cogconfig.sh

Note: When the cogconfig.sh file is executed for the first time or the configuration is incomplete you may get unexpected Warning messages.


These messages will be address once the properties of the cognos configuration have been updated and the configuration are saved.

Setting up the IBM® Cognos® Configuration tool, dependencies and requirements

Using a terminal session navigate to the following directory $RRDI_HOME/rrdi/clm/cognos/webapps/p2pd/WEB-INF/lib. There will be several files at this location.



All the files in this directory need to be copied to the $RRDI_HOME/cognos/webapps/p2pd/WEB-INF/lib directory.


cp ./*.jar /opt/IBM/RRDI206/cognos/webapps/p2pd/WEB-INF/lib/

To confirm the cp command success, use Command ls -ltrh:


Example ls -ltrh /opt/IBM/RRDI206/cognos/webapps/p2pd/WEB-INF/lib/

This will provide information on the files that where copied. Look for the same list of files as in the $RRDI_HOME/rrdi/clm/cognos/webapps/p2pd/WEB-INF/lib with a timestamp group together.

The next step is the JDBC drivers file for the database vendor the application's p2pd.ear file will be using.


Navigate to the DB2 software or instance home java directory. Instance home: $DB2_INST_HOME/java Software Home: DB2_SOFT_HOME/java

Note: The instance home directory can be a Database or Native Client instance.



Copie the 4 file to the $RRDI_HOME/cognos/webapps/p2pd/WEB-INF/lib directory:

db2jcc4.jar db2jcc.jar db2jcc_license_cu.jar db2policy.jar

The following two comment will execute the steps:

cp ./db2jcc*.jar /opt/IBM/RRDI206/cognos/webapps/p2pd/WEB-INF/lib/ cp ./db2policy.jar /opt/IBM/templateRRDI/cognos/webapps/p2pd/WEB-INF/lib


As in the last copy task we can verify the task by using the ls -ltrh

Example: ls -ltrh /opt/IBM/RRDI206/cognos/webapps/p2pd/WEB-INF/lib/




Note: this documents uses a Linux environment as an example of the RRDI setup. IBM RRDI 206 and Insight 1113 configuration of SQL server in a Linux WeSphere application server environment is not presently supported. This configuration example is in case this document is use for reference to manually configure on a Windows operating system.

Start the IBM® Cognos® Configuration tool, and configure the Cognos environment

Note: The method to invoke cogconfig.sh will open a Java window, it is assumed that the terminal session is setup to display X Window session or a desktop application for Linux. This document does not address the setup of the X window environment.

To start the Cognos configuration tool first navigate the to the $RRDI_HOME/cognos/bin64 directory using a terminal session that has access to a Linux desktop or X Window session.

Example of Path: /opt/IBM/RRDI206/cognos/bin64

Invoke the configuration panels using the following command #> ./cogconfig.sh from the terminal session.



Click the Environment tab. Change the gateway URI from http://localhost:80/cognos8/cgi-bin/cognos.cgi


To http://<$SERVER_NAME>:<$SERVER_PORT>/reporting/servlet/dispatch, refer to section “Create and configure a new WebSphere Application Server profile to host the report server on a federated instance” for server information required.


For the following fields:

Dispatcher URIs for gateway External dispatcher URI Internal dispatcher URI Dispatcher URI for external applications Content Manager URIs

Change all the ports from 9300 to the port number of the WebSphere Application Server profile and change p2pd to reporting.



Click the Portal Services tab. In the Location of 'applications.xml' field, change the port from 9300 to the port number of the WebSphere Application Server profile.





The next step is to remove the 'IBM Cognos services' > 'IBM Cognos' by selecting the node, right click to get the context menu, and select delete in this menu.


As a result, the node will be removed from the panel.


Disable the 'IBM Cognos services' property 'Query service enabled', set the property to false. Select the value column and pull down the list picker and select 'False'




Set the Security > Authentication > Cognos node, by default the 'Allow Anonymous access?' property to 'False'. Which is the recommendatio RRDI, especially if your planning to implement the Jazz Name space.


Right Click on the 'Authentication' node, move cursor to 'New resource' and select 'Namespace …'


A new window will open, in the Name Files type 'Jazz' an in the 'Type' List select 'Customer Java Provider'

And press 'OK' Button. This action will create a new node with the name provided in previous step.



You will find the 'Namespace ID' field mark with a red X, Identifying the that a value is mandatory, type in 'Jazz'. In the 'Jazz class name' Enter 'JazzNamespace'


Note: The cognos configuration name space work in tandem with the jazzns_config.xml files. For the location of the the jazzns_config.xml file review section 'Setup the Jazz Name Space, create the jazzns_config.xml file'. The location of the configuration file is predefined in the software, therefore Its location is implicit. You do not need to Indicate the location on this panel, simply make sure the file jazzns_config.xml file has been created, configured and is at the expected location.

The next node to configure is the Content Store database configuration. In the left side panel expand and select the 'Data Access > Content Manager > Content Store'.


By default the 'Content Store' node will be setup for DB2. If DB2 is the database Software being used skip the Delete and Add new resource step, and stop at the section were setup the database connection details detailed.

If the Database requirements are not DB2, then right click on the 'Content Store' node and delete the element.


Then once more on the left panel, right click on the 'Content Manager' node and expand the 'New Resource' menu item and select 'Database ...'


A new configuration window titled: 'New Resource – Database' will appear. Type in the Name 'Content Store' and select the targeted Database vendor you require. Select 'OK when the action are completed.


Note: When selecting the Oracle software, please use the (Advanced) configuration element.

In this example we will configure a DB2 Database on a remote location named ricm: Database server and port number: $SERVER_NAME_QUALIFIED:$PORT The User ID and password: Select the pencil and in the new window input the user name, Password and Confirm password fields Database Name: Input the database name


Select the 'OK' button.

You can test the voracity of the details by selecting the “Content Store” node, right click and select “Test”.


The test results should be all green check marks.


Note: The test checks the cryptographic and the database connection, but does not validate the existence on the Content Store database object. If the repository is uninitialized it will be created one the Cognos Application server is started up.

In the context menu element of the 'Content Store', the Generate DDL is also available. The this can generate the Initialization script for the DB2 database fi the DBA want to have more control over the database creation. This option is only available with DB2 database instances.

A common error is that the JDBC driver are not available. Review 'Setting up the IBM® Cognos® Configuration tool, dependencies and requirements' section the drivers for the database may be missing.

Click Save and click Close.


A few validation step will be executed and should all report back a green arrow.

More about the Content Data Store Configuration, Other database software

Oracle database

Oracle Descriptor (Property Name Database specifier):




Oracle example:


SQL server Database:


The following will provide more details on the Dtabase management system supported.

Creating the data warehouse and content store databases http://pic.dhe.ibm.com/infocenter/rentrpt/v1r1m1/topic/com.ibm.rational.raer.install.doc/topics/c_postinstall_manual_db.html

--++Build the report server enterprise archive (EAR) file

Note: Many files in the following section are being modified manually. Backing up file is not specified at any steps, but it is recommended to do so. It is also recommended not to backup the files at there same location specified since these files can be eventually included in the packaged application. This will allow you to restore the file to its original state in case an unexpected character is introduced to the file or to avoid

Prepare the p2pd.ear file build

Edit the $RRDI_HOME/cognos/webapps/p2pd/WEB-INF/web.xml.withCM file in an editor and add the following lines just before the ending </web-app> tag:

<welcome-file-list> <welcome-file>servlet/dispatch</welcome-file> </welcome-file-list>

<security-constraint> <web-resource-collection> <web-resource-name>All</web-resource-name> <url-pattern>/servlet/dispatch</url-pattern> <http-method>GET</http-method> </web-resource-collection> <user-data-constraint> <transport-guarantee>CONFIDENTIAL</transport-guarantee> </user-data-constraint> </security-constraint>

Example: /opt/IBM/RRDI206/cognos/webapps/p2pd/WEB-INF/web.xml.withCM

Note: If your are planning to setup the RRDI server fo SSL encryption, meaning using the HTTPS protocol, use <transport-guarantee>CONFIDENTIAL</transport-guarantee>

If you planning not to enable SSL which mean you will be using HTTP protocol use <transport-guarantee>NONE</transport-guarantee>

The <security-constraint> depends on your requirements. The global security is required for the CLM solution setup. This mean that the Dmgr has a prerequisite to use the 'Enable application security' and check box must be checked. If the HTTPS constraint isn't required, use the NONE transport-guarantee. This will disable the constraint for the RRDI application only and avoid application server URL redirection.


If your planning to setup HTTPS eventually, but will start with the HTTP protocol first, the CONFIDENTIAL should be used. You will need to expect that your URL will be redirected to the default HTTPS protocol when reaching to the Web Container URL on a browser connection. Using a HTTP proxy server in the mix will change this behavior but is not within the scoop of this document.

In this example the <transport-guarantee>NONE</transport-guarantee> will be used.


A second update to the web.xml.withCM is required at line 58 of the file.

The following line


Must be updated to


For Insight, you will need






Save the files and close it.

Next Navigate to the $RRDI_HOME/setup/rrdi/clm/cognos/configuration/

Example: cd /opt/IBM/RRDI206/setup/rrdi/clm/cognos/configuration

And Copy to $RRDI_HOME/cognos/configuration directory the AAA.properties files, and validate if the file has been copied.

Command example: “cp AAA.properties /opt/IBM/RRDI206/cognos/configuration/AAA.properties “

Result Example:


Note: If AAA.properties file is from an Insight installation the property “authentication.listener.1” need to be updated.





Edit the $RRDI_HOME/cognos/war/p2pd/build.xml file in an editor and remove prefix="servlet" from lines 123 and 160 and add a new line with . Doing so will change to

Example of path: /opt/IBM/RRDI206/cognos/war/p2pd/build.xml

Line 123 From


Line 123 to


Line 160 + 1 due to addition of line at line 123 From


Line 160 +1 to


Then add the RRDI default skin into the webcontent directory. Navigate to $RRDI_HOME/cognos/webcontent/skins.

Example: /opt/IBM/RRDI206/cognos/webcontent/skins

And execute command 'cp -R $RRDI_HOME/setup/rrdi/cognos/webcontent/skins/rrdi/ .'



Build the p2pd.ear file build

Launch the cognos configuration tool, see section 'Start the IBM® Cognos® Configuration tool, and configure the Cognos environment' to start the tool.

Select Actions > Build Application Files to launch the Build Application Wizard.


In the Build Application window, select the following entries and then click Next.

Application > Check, 'Include static files from the Webcontent folder' [Optional] Application > Check, 'Include documentation and sample files from the Webcontent folder' Application Server type > Select the option IBM WebSphere


Change the context root from p2pd to reporting.


Click Next to build the EAR file.


Click Finish once the EAR file is built.

Close Cognos Configuration.

Install the report server enterprise archive (EAR) file.

Make sure the Dmgr is up and running, by logging in to the WebSphere Dmgr console. Using URL, https://$SERVER:$PORT/ibm/console/

Example: https://myserver.ibm.com:9047/ibm/console/logon.jsp


Using the left side panel, navigate to and expand the 'Server types' and select the link 'WebSphere application servers'. Make sure the RationalReportServer is down. If it is not stop, then select the check box for the 'RationalReportServer' and click on stop.


Expand the Applications > Application Type and select the WebSphere enterprise application node.


Verify that the 'IBM Cognos' application was not deployed previously. If it has 'Stop' the service and 'Uninstall'. From the table view in the right panel, above the list of previously deployed application select the 'Install' Button.


On this new page, select the 'Remote file system' and browses to the targeted node and location of the p2pd.ear file.

First Identify the node that containts the EAR file. In this case myserver2node02.


On the next page select the root directory '/',


Continue to navigate the file system until you reach the &RRDI_HOME/cognos directory.


In this location you will find the p2pd.ear file, select the file.


And select the 'OK' button at the bottom of the page.

The page will return to the initial 'Enterprise Application' page. The 'Full Path' field will have a complex path for the file location.

Click on the 'Next' button.


Accept default values and lick on the 'Next' button.


The next page will, and option page, no changes are needed, click on next.


The next page will be the 'Map module to servers' configuration page. You can notice in the Servers column of the table, the wrong server is targeted. Server1 is not the intended server. To change the server Highlight the proper sever in the 'Clusters and servers' list box. Check the 'Select' column of the table and click on 'Apply' button.


Review the change and make sure that in the Server Column, the right server has been targeted. Select the 'Next' button if all is as expected.


Unless there is a particular virtual host configuration you are targeting, lead the default_host selection in the 'Virtual Host' column. Click on 'Next.


This will lead you to the summary page, Click on 'Finished'.


The next page will be a process status log. Once the message 'Application IBM Cognos Installed successfully' if displayed, click on the 'Save' link.


The tool will send you back to the 'Enterprise Applications' page, you should now see the newly added 'IBM Cognos' application. The status will be a red X since the service will not have been started.


Changing the application deployed on a Dmgr instance will affect the node targeted. This node will have to be synchronized to reflect the change in the Dmgr status.

Using the Left side Panel, navigate 'System administration' and select the 'Nodes' link. You will see the 'Nodes' table in the right side panel. You should notice that the status is not the icon for a synchronized node. Using the 'Select' Column, make sure the check box is checked for the unsynchronized node and select the 'Full Resynchronized' button.


The status will align itself to the new and correct status.


The next step is to start the 'RationalReportingServer'. Using the left side panel navigate to the 'WebSphere application servers' link, and restart the targeted server.


The next step is to start the 'RationalReportingServer'. Using the left side panel navigate to the 'WebSphere application servers' link, and restart the targeted server.


When the IBM Cognos application is starting up, it always take a few minutes to for the the application's UI to come up properly. If you test that the report server's URL and you are challenged with the following message it may simply mean you need to wait.


If you want to make sure of the server startup sequence is complete, review the $RRDI_HOME/cognos/logs/cogserver.log file for the message 'The product is ready to use'.

Example: /opt/IBM/RRDI206/cognos/logs/cogserver.log


Once the message appears in the log file you can test the report server URL.

Open a browser of you choice, and in the address bar enter the URL configured In the Cognos configuration's Gateway URL. In this case we chose;

Example URL: HTTP://myserver2.ibm.com:9085/reporting

You will challenged since the Jazz Name Space has been configured, and the URL will be targeting the Jazz Server's login page. The user name and password you choose should be part of the JazzAdmins user group, in this case we select wasadmin.


If you user name and password are good, then you should see the Base Cognos UI.


This means the application server profile is up an running, and the jazz name space is configured correctly. You will notice that the page style is not the expected Blue Rational Banner. This will be corrected in the next steps.

Setting the Rational Reporting style as the default style Method 1

Open a command/terminal window and navigate to $RRDI_HOME/setup/tool/setstyle

Example: /opt/IBM/RRDI206/setup/tool/setstyle

Note: Our documentation mentions that we support only the 'bash” shell, but in the setStyle.sh the shell is set to “ksh”, Korn Shell, some Linux install may not have the shell setup. It is not required to install the shell. Simply remove or comment the first line of the setStyle.sh script. This example will use the comment out approach.



Run the following command to set the Rational Reporting style:

./setstyle.sh -url $report_server_url -namespace $namespaceID -user $userID -password $password

For example:

./setstyle.sh -url http://myserver2.ibm.com:9085/reporting/servlet/dispatch -namespace Jazz -user wasadmin -password wasadmin



The next time you login you should to the tool you will find the default Style for the Rational report UI.


Setting the Rational Reporting style as the default style Method 2

Using the GUI interface for Cognos navigate to the IBM Cognos Administration. Pull down the launch menu, and select “IBM Cognos Administration'

Select the “Configuration” tab, and select the “Styles” link on the left panel.


You will be in the Styles panel, on the right of the interface. Find the “New Styles” icon and select it.


An new configuration window will appear titled “Specify a name and description”. In the “Name” field enter the value “RRDI” and in the “Screen tip” Field enter the valuer “Style for Rational Reporting”. Click next when the updates are completed.


The window title will change to “Specify the location and preview resource”. The two fields will require a value. The “Style resources location” value will be “rrdi”, the case is important!. And, the “Preview resource” update will be “preview.htm”. Click on “Finish” button once the updates are completed.


Once the the Style is set, it is possible to validate that the setting is working by doing a right-click selection on the newly created Style “RRDI”, and choose “Preview this Style”.




Note: This process is dependent on the section “Build the report server enterprise archive (EAR) file” > “Prepare the p2pd.ear file build” Moving the RRDI skins.

The next step is to setup the style as a default for users.

Still using the “IBM Cognos Administration” Page, select the “Security” tab, and on the right side panel, choose the “isers, Group, and Roles” link. Once landed the page look for and select the“Cognos” link.


On the Right side on the page you will look for the “Edit Default User Profile” Icon.


The right side panel Title will now be “Set properties – User Profile”. You will then select the “Preference” and set the style field to “RRDI”.


Click OK, at the bottom of the page to finish the task.

Note: Any new users login into the tool for the first time will have the default Rational Reporting style, but since the wasadmin user has already logged into the tool once the style must be set within his own preferences.


The user's preference page will open, then set the “Style” to RRDI.


This will reset the wasadmin user's style to the Rational Reporting style.


The next task is to setup the report model and template. The order of which these are loaded is important. Since the template are dependent on the Model you must make sure that the model are loaded before the template.



Log into the Jazz Team Server admin page, and navigate to the, “Report” > “Download” page.

URL: https://$SERVER:$PORT/jts/admin

Example: https://myserver.ibm.com:9443/jts/admin


On the Download page look for the “Archive Files for Rational Reporting” link and select it.


This will prompt you to save the file. Make sure the save option is selected and select the “OK' Button. The target location is not important select any local you deem appropriate. In this example the default browser downloads page is used.


Navigate to the directory which the file resides and Unzip it. Repeat for the qm/admin and ccm/admin pages

Using the default file name “Cognos_Report_Server_Archive_Files.zip”, there should be numbers copies of the file.

Cognos_Report_Server_Archive_Files.zip Cognos_Report_Server_Archive_Files(1).zip Cognos_Report_Server_Archive_Files(2).zip

Unzip the zipped files “Cognos_Report_Server_Archive_Files.zip” using command:

unzip Cognos_Report_Server_Archive_Files.zip



Execute the same command for the second zipped file.

Exampe: unzip "Cognos_Report_Server_Archive_Files(2).zip"

Note: Expect files rewrites, these archive are design to work with different combinations of CLM Servers. The assumption configuration supports a default CLM Jazz environment. If you are challenged with such a situation simply accept all replacements.


Navigate to the $DOWNLOAD_DIR/Rational Reporting


/root/Downloads/Rational Reporting Install

The expected file list:

Cognos Change and Configuration Management Reports.zip Cognos Quality Management Reports.zip Cognos Requirements Management Reports.zip Rational Reporting Data Model (DW+CALM)-no-security.zip Rational Reporting Data Model (DW+CALM).zip Rational Reporting Data Model (RQM).zip


Copy all of the files listed above to the $RRDI_HOME/cognos/deployment directory to the $RRDI_HOME/cognos/deployment directory.

Example: cp *.zip /opt/IBM/RRDI206/cognos/deployment/


The files in the ../cognos/deployment directory will not be available to the report UI. A Report server restart will be required.

Once the server has been restarted, open the “IBM Cognos Administration”


Then navigate to the “Configuration” tab “Content Administration” Find the “New Import” icon.


A list of archives to impart will be available.

Important! The order the file are imported is crucial. The Data Model must be imported first. Only after the models are loaded can the report templates be imported.


You also need to consider the requirements, when choosing which Data Models to import. If you want the reports to match the project's security policies for the Jazz solution, choose the “Rational Reporting Data Model(DW+CALM)”. If you do not require to follow the policies use instead “Rational Reporting Data Model(DW+CALM)-no-security”. It is not possible to implement both files.

The Following step are true for all files imported, and may have to execute these steps up to five time, depending if you need the RMQ and all report packages.

First, import the “Rational Reporting Data Model (RQM), Select the option button and click on “Next”


Like many of the following step, you simply select the “Next” Button,


The next steps will present a check box. Check it and Click on “Next”


Select the “Next” button


Select “Next”




Make sure the table list, at the minimum, has an element to import. Otherwise, it may mean a forgotten check on a check box, select “Next”,


Make sure the option it select for “Save and run once”, Click on the “Finish' button.


Make sure the “Now” option is set and move on to the next panel


Select, “OK”

Repeat the above steps for the “Rational Reporting Data Model (DW-CALM)”.


Once the import of Data Model is completed, the “Configuration” > “Content Administration” view should contain two values.


The “Configuration” > 'Data Source Connection” View will contains a list of data source definition for the Rational products.


And, The administration user's “IBM Cognos connection” home will have a 'Reporting Data Model” Folder.


The Reports packages are next. You can choose to import these in any order. The steps to import are the same are the import for the data models. Select a report package, and follow the step described for the data model. Click “Next”


The exception in the steps is that the report packages may contain two check box to check.


When all data models and report package are loaded, the “Content Administration” view should have 5 packages listed.


The “IBM Cognos Connection” home view should have three folders.








Related topics: Deployment web home, Deployment web home

External links:

Additional contributors: TWikiUser, TWikiUser

Edit | Attach | Printable | Raw View | Backlinks: Web, All Webs | History: r5 < r4 < r3 < r2 < r1 | More topic actions...
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Contributions are governed by our Terms of Use. Please read the following disclaimer.
Ideas, requests, problems regarding the Deployment wiki? Create a new task in the RTC Deployment wiki project